Docusaurus versioning #2
Conversation
samricotta
force-pushed
the
sam/versioning
branch
2 times, most recently
from
d241d00
to
b888dbf
Compare
samricotta
force-pushed
the
sam/versioning
branch
from
df543a0
to
fdefd62
Compare
samricotta
force-pushed
the
sam/versioning
branch
from
fbecbf1
to
c7d8c0d
Compare
|
A lot of this will have to be checked once it is on staging |
custom-version-plugin.js
Outdated
There was a problem hiding this comment.
Not too sure what this does. Where is that plugin added as well?
Could this get a small doc? I am trying to understand how it created those files, as they aren't in /docs folder.
There was a problem hiding this comment.
This is just the action they use in docusaurus, i was having trouble last night getting it to build so trying all options. The custom plugin is specified in docusaurus.config.js. It uses all the files from main and any of those that arent the same, they have their own version. Additionally, there is version_config which removes specific files or paths from versions. This way its very clear as to what is in each version when its built
There was a problem hiding this comment.
I am not seeing it in the docusaurus.config.js. Which main are we talking about? This repo?
It uses all the files from main and any of those that arent the same, they have their own version.
Ok, so the process of adding a custom content for a version is manual right? If so, this means the versioning is definitely incomplete, won't it be a hell to maintain?
Again, only if my understanding is correct: If I want to change the content only for main, does not this mean I need to first copy the old content to each of the versioned SDK versions, where I want the content to stay the same and then edit the latest content?
There was a problem hiding this comment.
lol good catch, I removed this by accident c7d8c0d#diff-a038096cbdea434999e1dce5ab497212f1fe18204dde1a027ce3bdd663261a2aL210
but ill fix this up.
For the second point, the process of adding custom content will be automated. I have been working on a script that for any md file that is updated, removed or added will be copied to the specific version/main within the docs repo.
docusaurus.config.js
Outdated
| @@ -13,7 +13,7 @@ const config = { | |||
| tagline: | |||
| "Cosmos SDK is the world's most popular framework for building application-specific blockchains.", | |||
| url: "https://docs.cosmos.network", | |||
| baseUrl: "/", | |||
| baseUrl: "/cosmos-sdk-docs", | |||
There was a problem hiding this comment.
Cool! It could be handy to have this tiny thing in a separate PR so that https://cosmos.github.io/cosmos-sdk-docs can work sooner.
|
@julienrbrt Yeah this is why it needs to go on staging so i can literally proof read every single page and compare as there are still a lot of manual changes to happen |
|
Hey checking in on this. Are we good to merge? |
Within in the sdk repo, versioning is split between vuepress and docusaurus. This PR migrates all versions over to this repo whilst using the custom plugin to build the docs per version.
This PR is to be merged before #1.
There will be another PR that will live in the sdk repo to copy over any changes on MD files using a GitHub Actions workflow which is triggered on any deployment.