-
Notifications
You must be signed in to change notification settings - Fork 46
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
#1932 Publish v13 Docs using mike #1967
Changes from 13 commits
bb1ac70
ddfe17d
fee2d9e
99f5c85
5dd79fc
7b83061
e8f0781
e40b3cd
9572f37
0fb8d69
9b90cc5
6acb009
ad25fce
fdf68c8
6bbb8dc
40c5f6c
5e3e69e
36b0864
1c76715
File filter
Filter by extension
Conversations
Jump to
Diff view
Diff view
There are no files selected for viewing
Original file line number | Diff line number | Diff line change |
---|---|---|
|
@@ -66,10 +66,28 @@ npm install | |
3. Install required mkdocs packages using pip3. | ||
``` | ||
pip3 install -r requirements.txt | ||
pip3 install mike | ||
``` | ||
|
||
4. Run below command to start mkdocs server. | ||
``` | ||
4. Run below commands to use `mike` to deploy multiple versions of docs. | ||
```sh | ||
# Initially delete everything from gh-pages branch to start creating version folders. | ||
mike delete --all | ||
|
||
# If above command throws an error please run below mkdocs command and then run mike deploy | ||
mkdocs gh-deploy --force | ||
|
||
# This command will create a folder named as v13 in gh-pages branch. | ||
mike deploy --push --update-aliases v13 latest | ||
mike set-default v13 | ||
|
||
# This command will create a folder named as v12.x in gh-pages branch. | ||
mike deploy --push --update-aliases v12.x | ||
|
||
# Test changes in local. | ||
mike serve | ||
|
||
# If above command doesn't reflect any changes made to docs please run below mkdocs command | ||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Can you write this as: "If you are working on Elyra Canvas documentation content, you should run the following command, instead of the There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Sure, I have updated accordingly. |
||
mkdocs serve | ||
``` | ||
|
||
|
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
What is this for?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
This is to create initial setup in
gh-pages
which will create a folder namedv12.x
and place all the doc changes in it. So when we select on v12.x from dropdown it will fetch docs from this folder.There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Since we won't have v12 docs should this be removed?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Yes this can be removed if there is no v12 docs. Should I remove this ?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Yes, I think we should. @tomlyn do you agree?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Sure. I have removed that from Readme.