Skip to content
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

Closed
2 tasks done
jmeridth opened this issue Dec 26, 2023 · 5 comments
Closed
2 tasks done

Backport doc build changes for versioned docs #12414

jmeridth opened this issue Dec 26, 2023 · 5 comments
Assignees
Labels
area/build Build or GithubAction/CI issues area/docs Incorrect, missing, or mistakes in docs type/backport Backport of an existing PR to an older release branch type/feature Feature request

Comments

@jmeridth
Copy link
Member

jmeridth commented Dec 26, 2023

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 👍.

@jmeridth jmeridth added the type/feature Feature request label Dec 26, 2023
@jmeridth jmeridth self-assigned this Dec 26, 2023
@jmeridth jmeridth added the area/docs Incorrect, missing, or mistakes in docs label Dec 26, 2023
jmeridth added a commit to jmeridth/argo-workflows that referenced this issue Jan 3, 2024
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]>
@jmeridth
Copy link
Member Author

jmeridth commented Jan 3, 2024

@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:

  1. For backporting we need to switch to readthedocs links but do we, for the backports, want to change to https://argo-workflows.readthedocs.io/en/[version] (e.g., https://argo-workflows.readthedocs.io/en/v3.5.2) or have all backports point to latest (e.g., https://argo-workflows.readthedocs.io/en/latest)? I assume the version in the URL and we can point the version build in the readthedocs UI.
  2. For the stable url we'll point it in the readthedocs URL at the latest stable version SHA. That's how it is done. You good with this? (as previously mentioned by @agilgur5 here)
  3. How far back do we want to go?

@terrytangyuan
Copy link
Member

v3.5.2 and v3.4.14 should be fine IMO

@terrytangyuan
Copy link
Member

https://argo-workflows.readthedocs.io/en/[version] (e.g., https://argo-workflows.readthedocs.io/en/v3.5.2

This looks better

@jmeridth
Copy link
Member Author

jmeridth commented Jan 3, 2024

@terrytangyuan We will need to move the tag for each release to the HEAD of their perspective release-* branch.

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 release-v3.5.2 branch.

Is this okay?

@agilgur5
Copy link
Contributor

agilgur5 commented Jan 4, 2024

v3.5.2 and v3.4.14 should be fine IMO

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:
Screenshot 2024-01-03 at 9 10 30 PM

@terrytangyuan We will need to move the tag for each release to the HEAD of their perspective release-* branch.

I would suggest just changing the branch for the minor, i.e. release-3.5, to similarly match Argo CD:
Screenshot 2024-01-03 at 9 11 55 PM

@agilgur5 agilgur5 added the area/build Build or GithubAction/CI issues label Jan 4, 2024
jmeridth added a commit to jmeridth/argo-workflows that referenced this issue Jan 5, 2024
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]>
jmeridth added a commit to jmeridth/argo-workflows that referenced this issue Jan 5, 2024
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]>
jmeridth added a commit to jmeridth/argo-workflows that referenced this issue Jan 5, 2024
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]>
jmeridth added a commit to jmeridth/argo-workflows that referenced this issue Jan 5, 2024
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]>
@agilgur5 agilgur5 added the type/backport Backport of an existing PR to an older release branch label Mar 9, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
area/build Build or GithubAction/CI issues area/docs Incorrect, missing, or mistakes in docs type/backport Backport of an existing PR to an older release branch type/feature Feature request
Projects
None yet
Development

No branches or pull requests

3 participants