Backport the new doc framework with mkdocs and related build changes #10321
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Signed-off-by: Alexander Trost <galexrt@googlemail.com> (cherry picked from commit 7443144)
Deploying a custom CSI image is more of a standalone topic under the CSI configuration docs. There is no need for the upgrade guide to have the details about CSI images. Signed-off-by: Travis Nielsen <tnielsen@redhat.com> (cherry picked from commit b6c2b99)
The ceph upgrade guide is factored out into a separate document to help simplify the flow and make the different types of upgrades more easily discoverable. Signed-off-by: Travis Nielsen <tnielsen@redhat.com> (cherry picked from commit 3e0f26a)
The requirements_docs.txt is expected by the build.docs build target in build/release. Since the txt file was at the root of the repo, the build was failing to be pubished when it didn't find the file in build/release. Signed-off-by: Travis Nielsen <tnielsen@redhat.com> (cherry picked from commit 557feb2)
Signed-off-by: Alexander Trost <galexrt@googlemail.com> (cherry picked from commit a17575f)
Signed-off-by: Alexander Trost <galexrt@googlemail.com> (cherry picked from commit 0d815c0)
The doc build generation script is failing to install the needed dependencies for mkddocs. Signed-off-by: Travis Nielsen <tnielsen@redhat.com> (cherry picked from commit 03a091e)
The docs failed to publish with the mkdocs.yml in the root folder instead of where the docs are being built. Signed-off-by: Travis Nielsen <tnielsen@redhat.com> (cherry picked from commit c375bbd)
Signed-off-by: Gaurav Sitlani <gaurav@koor.tech> (cherry picked from commit 84c53d1)
The push image build CI action is mistakenly running on arm64 instead of amd64, which is failing the build since it only expects amd64. Signed-off-by: Travis Nielsen <tnielsen@redhat.com> (cherry picked from commit 5793582)
The setup tools package and libgit2 are required on ubuntu 18.04 in order to install the mkdocs framework and publish the docs. After we move to ubuntu 20.04 this should no longer be necessary. Signed-off-by: Travis Nielsen <tnielsen@redhat.com> (cherry picked from commit 2404fe1)
Resolves rook#10282 Signed-off-by: Alexander Trost <galexrt@googlemail.com> (cherry picked from commit a156dc3)
Signed-off-by: Alexander Trost <galexrt@googlemail.com> (cherry picked from commit 2f75104)
Signed-off-by: Alexander Trost <galexrt@googlemail.com> (cherry picked from commit 46fa71c)
Signed-off-by: Alexander Trost <galexrt@googlemail.com> (cherry picked from commit 548f723)
Signed-off-by: Alexander Trost <galexrt@googlemail.com> (cherry picked from commit c149d87)
Signed-off-by: Alexander Trost <galexrt@googlemail.com> (cherry picked from commit de5777c)
|
Hi @travisn, this pull request was opened against a release branch, is it expected? Normally patches should go in the master branch first and then be backported to release branches. |
|
@galexrt If this looks good, please go ahead and merge so we can watch closely and iterate again on the build if anything is still needed. |
galexrt
approved these changes
May 25, 2022
10 tasks
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Description of your changes:
The stabilization of the new docs has been completed in master, now we can backport all the changes to the release-1.9 branch. This is done with the bulk manual backport so we don't have all the intermittent build issues that were experienced in master.
Checklist:
skip-cion the PR.