soroban-docs icon indicating copy to clipboard operation
soroban-docs copied to clipboard

[epic] migrate Soroban Docs into Stellar Docs

Open ElliotFriend opened this issue 1 year ago • 8 comments

Since the Stellar Mainnet validators have affirmatively voted to upgrade the network to protocol version 20, now we begin the task of combining this documentation repository and the stellar/stellar-docs repository.

This issue will serve to track all the work needed to move content, as well as redirect where necessary.

The general process will be:

  1. We'll create a PR in the stellar-docs repo that serves to put the content of a section of documentation from this repo into the new one.
  2. A corresponding PR will be made in the soroban-docs repo that will redirect URLs and remove content (where applicable) from this repo.

Once that PR is ready, rinse and repeat. Several of these changes may involve merging main back into the feature branch along the way.

Done

  • [x] Migrate the content for Tools section (stellar/stellar-docs#304)
  • [x] Redirect tools/SDKs URLs (#739)
  • [x] Put up a Docusaurus announcement bar on stellar-docs that says "pardon our dust" or something. (stellar/stellar-docs#311)
  • [x] Put up a Docusaurus announcement bar on soroban-docs that says "we're moving" or something. (#742)
  • [x] Look into versioning multiple software products (this stackoverflow question might help)
  • [x] Research the ideal way to move content while preserving (at least some?) git history
  • [x] Migrate content for Soroban RPC section (stellar/stellar-docs#325)
  • [x] Redirect Soroban RPC section URLs (#757)
  • [x] Migrate content for Learn section (stellar/stellar-docs#354)
  • [x] Redirect Learn section URLs (#769)
  • [x] Migrate content for Reference section (stellar/stellar-docs#364)
  • [x] Redirect Reference section URLs (#772)
  • [x] Migrate content for Smart Contracts section (stellar/stellar-docs#388)
  • [x] Redirect Smart Contracts section URLs (#778)
  • [x] Migrate content from Dapps challenge (stellar/stellar-docs#497)
  • [x] Redirect Dapps challenge URLs (#781)

In-Progress

  • [ ] Consider docusaurus updates (stellar/stellar-docs#355)
    • [x] upgrade to latest v2 version (stellar/stellar-docs#405)
    • [ ] upgrade to latest v3 version (do this after the dapps challenge)

ElliotFriend avatar Feb 21 '24 20:02 ElliotFriend

Hi Elliot great work,

I was looking into one of the Todo points you mentioned

  • Research the ideal way to move content while preserving (at least some?) git history

Have you explored using the --allow-unrelated-histories flag? Might be a way to achieve that.

thisBrian avatar Feb 26 '24 22:02 thisBrian

Have you explored using the --allow-unrelated-histories flag? Might be a way to achieve that.

Hi, Brian! Thanks for the suggestion!

I've come across the unrelated histories flag as a probable solution, but haven't yet taken the time to figure out precisely how to use it. Do you have any experience with it? If so, I'd love some pointers.

For a quasi-hypothetical example: Suppose I wanted to take all of the files that are located in the /api directory in the soroban-docs repo and bring it into the stellar-docs repo, maybe into a new directory like /api/soroban-rpc. Is it possible to pick and choose just a single directory to do that with? Or, would I need to do it with the whole working tree? Does it matter that the source/destination directories have different paths from the repo root?

Not that you have to have the answers lol, just tossing out some of the thoughts that have been rattling around in my head.

Thanks again!

ElliotFriend avatar Feb 27 '24 04:02 ElliotFriend

Hi Elliot, those are very good questions.

Our team was doing it when migrating to a monorepo but we had additional tooling in place. I will look into cloning and creating a test repo from the soroban docs -> stellar-docs directory case and see if I can replicate that specific scenario. Things are a bit busy at the moment but I will make some time around the next couple of days or so to test it out 👍

thisBrian avatar Feb 28 '24 23:02 thisBrian

Hi, if I want to submit a PR to add Java SDK example here, is it better to wait until the migration is completed and then submit it to stellar-docs, or is it better to submit it to this repo now?

overcat avatar Feb 29 '24 03:02 overcat

Things are a bit busy at the moment but I will make some time around the next couple of days or so to test it out 👍

@thisBrian I actually did some toying around with it yesterday, and I think i did reasonably well with the soroban-rpc stuff. It's on this PR: stellar/stellar-docs#325 I found a couple people posting guides for similar stuff online, but I don't exactly recall which ones I used. I'll try to write down a "post-mortem" for how I did it (for future reference) today or tomorrow.

... is it better to wait until the migration is completed and then submit it to stellar-docs, or is it better to submit it to this repo now?

@overcat Is your Java example, already written and just "looking for a home" or will it need some time and iteration? My gut says go ahead and submit it here. We could target the soroban-internals section for the week of March 11 perhaps? Would that be enough time?

ElliotFriend avatar Feb 29 '24 16:02 ElliotFriend

@overcat Is your Java example, already written and just "looking for a home" or will it need some time and iteration? My gut says go ahead and submit it here. We could target the soroban-internals section for the week of March 11 perhaps? Would that be enough time?

We have already submitted and merged it.

overcat avatar Mar 08 '24 06:03 overcat

Hi, was not able to access this page again.

After the merging, would the page be moved to another path, or would still be accessible here?

https://developers.stellar.org/docs/anchoring-assets/anchor-platform/sep24/integration?q=anchoring+assets+anchor+platform+sep24+integration

Screenshot 2024-03-08 at 10 07 50 AM

gabrieladeniji avatar Mar 08 '24 09:03 gabrieladeniji

Hi there! That page should be available here: https://developers.stellar.org/network/anchor-platform/admin-guide/sep24/integration

briwylde08 avatar Mar 14 '24 15:03 briwylde08