-
Notifications
You must be signed in to change notification settings - Fork 3.2k
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
Backport doc build changes for versioned docs #12414
Comments
relates to argoproj#12414 - [x] move over files to help with readthedocs build - [x] .readthedocs.yaml - [x] Makefile - [x] mkdocs.yml - [x] hack/check-mkdocs.sh - [x] docs/requirements.txt - [x] change links from github pages to readthedocs v3.5.2 Signed-off-by: jmeridth <[email protected]>
@agilgur5 @terrytangyuan Working on the first PR for this. The files mentioned in the description above make sense and confirming those on my forked project in readthedocs but I also realized we need to update the 460+ files that still have github pages links in them. This brings up a few questions:
|
v3.5.2 and v3.4.14 should be fine IMO |
This looks better |
@terrytangyuan We will need to move the tag for each release to the HEAD of their perspective Why? v3.5.2 tag is still pointed at old SHA that doesn't have the newly merged readthedocs configuration parts that is on HEAD of Is this okay? |
yea I was only gonna do latest patch of each minor as well. 3.4 and 3.5 are most important ofc, the rest we can take our time with, no rush to get those out, can just do them whenever anyone has any free time / wants to take those on. That's also what Argo CD currently has:
I would suggest just changing the branch for the minor, i.e. |
Relates to argoproj#12414 - [x] updated docs links to https://argo-workflows.readthedocs.io/en/release-3.4 - [x] updated github issues config (like we did in main) to point to latest Signed-off-by: jmeridth <[email protected]>
Includes fixes from argoproj#12464, argoproj#12466, argoproj#12465 - all authored by @agilgur5 Includes files list from argoproj#12414 description Signed-off-by: jmeridth <[email protected]> Co-authored-by: Anton Gilgur <[email protected]>
Includes fixes from argoproj#12464, argoproj#12466, argoproj#12465 - all authored by @agilgur5 Includes files list from argoproj#12414 description Signed-off-by: jmeridth <[email protected]> Co-authored-by: Anton Gilgur <[email protected]>
Includes fixes from argoproj#12464, argoproj#12466, argoproj#12465 - all authored by @agilgur5 Includes files list from argoproj#12414 description Signed-off-by: jmeridth <[email protected]> Co-authored-by: Anton Gilgur <[email protected]>
Summary
Keep track of doc build changes that need to be backported to prior versions so they can show as versioned docs on readthedocs.io (once #12360 merges)
Setup changes that need to be backported:
We'd still want the URL changes also from #12360 but instead of
/latest/
suffix it'd be the semver (e.g.,/release-[major].[minor]/
suffix)Message from the maintainers:
Love this enhancement proposal? Give it a 👍. We prioritise the proposals with the most 👍.
The text was updated successfully, but these errors were encountered: