docs: commit generated docs for readthedocs.org - #2535
Merged
zachaller merged 5 commits intoJan 26, 2023
Conversation
zachaller
changed the title
zachaller
marked this pull request as ready for review
January 24, 2023 16:20
zachaller
marked this pull request as draft
January 24, 2023 16:31
Contributor
Contributor
zachaller
marked this pull request as ready for review
January 24, 2023 17:22
Codecov ReportBase: 81.69% // Head: 81.66% // Decreases project coverage by
Additional details and impacted files@@ Coverage Diff @@
## master #2535 +/- ##
==========================================
- Coverage 81.69% 81.66% -0.04%
==========================================
Files 126 126
Lines 19136 19147 +11
==========================================
+ Hits 15634 15636 +2
- Misses 2709 2717 +8
- Partials 793 794 +1
Help us with your feedback. Take ten seconds to tell us how you rate us. Have a feature suggestion? Share it here. ☔ View full report at Codecov. |
If we do not commit the docs all the autogenerated docs do not show or work on argo-rollouts.readthedocs.org this also brings the pattern in line with and is probably why argocd does the same. Signed-off-by: zachaller <zachaller@users.noreply.github.com>
Signed-off-by: zachaller <zachaller@users.noreply.github.com>
Signed-off-by: zachaller <zachaller@users.noreply.github.com>
zachaller
force-pushed
the
fix-autogen-docs-readthedocs
branch
from
January 25, 2023 22:56
23a65b8 to
0b5b8f9
Compare
|
Kudos, SonarCloud Quality Gate passed!
|
leoluz
approved these changes
Jan 26, 2023
leoluz
left a comment
leoluz
left a comment
Contributor
There was a problem hiding this comment.
LGTM
We should probably investigate how to avoid having to manually generate those files and push. Maybe we could configure the build to take care of that.
zachaller
added a commit
that referenced
this pull request
Jan 26, 2023
* fix: commit generated docs for readthedocs.org If we do not commit the docs all the autogenerated docs do not show or work on argo-rollouts.readthedocs.org this also brings the pattern in line with and is probably why argocd does the same. Signed-off-by: zachaller <zachaller@users.noreply.github.com> * remove already included in make codegen cmds Signed-off-by: zachaller <zachaller@users.noreply.github.com> * static default value for doc generation Signed-off-by: zachaller <zachaller@users.noreply.github.com> * cleanup Signed-off-by: zachaller <zachaller@users.noreply.github.com> * typo Signed-off-by: zachaller <zachaller@users.noreply.github.com> Signed-off-by: zachaller <zachaller@users.noreply.github.com>
zachaller
added a commit
that referenced
this pull request
Jan 26, 2023
* fix: commit generated docs for readthedocs.org If we do not commit the docs all the autogenerated docs do not show or work on argo-rollouts.readthedocs.org this also brings the pattern in line with and is probably why argocd does the same. Signed-off-by: zachaller <zachaller@users.noreply.github.com> * remove already included in make codegen cmds Signed-off-by: zachaller <zachaller@users.noreply.github.com> * static default value for doc generation Signed-off-by: zachaller <zachaller@users.noreply.github.com> * cleanup Signed-off-by: zachaller <zachaller@users.noreply.github.com> * typo Signed-off-by: zachaller <zachaller@users.noreply.github.com> Signed-off-by: zachaller <zachaller@users.noreply.github.com>
zachaller
added
the
cherry-pick-completed
This file contains hidden or 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
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
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.
If we do not commit the docs all the autogenerated docs do not show or work on argo-rollouts.readthedocs.org this also brings the pattern in line with and is probably why argocd does the same.
https://cloud-native.slack.com/archives/C01U781DW2E/p1674574980825679
https://cloud-native.slack.com/archives/C01U781DW2E/p1674579723986039
vs
https://argo-rollouts.readthedocs.io/en/fix-docs-version/features/kubectl-plugin/
I also feel it makes sense to have these committed for things like different versions which is why readthedocs needs them as well
Signed-off-by: zachaller zachaller@users.noreply.github.com