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

issue-2983: Update doc titles #46

Merged
merged 3 commits into from
May 6, 2024
Merged

issue-2983: Update doc titles #46

merged 3 commits into from
May 6, 2024

Conversation

apinnick
Copy link
Contributor

@apinnick apinnick commented Apr 30, 2024

Fixes 2983

For 6.16.

@evgeni
Copy link
Member

evgeni commented Apr 30, 2024

This will require an update to the toc file.
CC @ShimShtein

@ShimShtein
Copy link
Contributor

@evgeni : #47

test/fixtures/toc.json Outdated Show resolved Hide resolved
@ShimShtein
Copy link
Contributor

@apinnick
Copy link
Contributor Author

apinnick commented May 1, 2024

@apinnick , the fails are actually relevant: https://github.com/RedHatSatellite/foreman_theme_satellite/actions/runs/8897047565/job/24431151567?pr=46#step:21:12

@ShimShtein That failure is strange. When I checked the failed links manually, they all worked. I am not sure how the "TOC" works, however.

@ShimShtein
Copy link
Contributor

The TOC file is actually the extract of the documentation links from not-yet-published docs downstream. This is the link structure that will be available later on. So we can anticipate any changes to the doc structure before the docs are actually published.

Copy link
Contributor

@Lennonka Lennonka left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Needs cherrypick to 6.15!

@ShimShtein
Copy link
Contributor

@evgeni I don't see a stable branch for the 6.15 equivalent version. What is our policy for this repo?

@evgeni
Copy link
Member

evgeni commented May 2, 2024

We don't have any breaking changes since the version that is in 6.15, so I think we can just push whichever the next release will be?

@ShimShtein
Copy link
Contributor

Apparently the documentation structure is about to change (see the failures in this PR).
We will need a version with documentation links as they are in 6.15 (with the fixes from this PR) and one for the next documentation structure.

@evgeni
Copy link
Member

evgeni commented May 2, 2024

Well, then we'll create a stable branch the moment we're breaking it :)

@ShimShtein
Copy link
Contributor

I think it's now - the change as it is in the original PR needs to be done to 6.15, and the new TOC + changes that come with it should go to the next version.

@evgeni
Copy link
Member

evgeni commented May 2, 2024

The TOC in this PR, is it for 6.15 or for "develop"?
The documentantion.rb in this PR, is it for 6.15 or "develop"?

@ShimShtein
Copy link
Contributor

The TOC is for develop, the documentation.rb is for 6.15 (but it will need adjustments for develop too - the errors that we see in the PR right now)

@evgeni
Copy link
Member

evgeni commented May 2, 2024

ok, can we have a toc for 6.15, merge the (test passing) result, then update both to develop and then we have a clean branch point

@ShimShtein
Copy link
Contributor

Updated the TOC to 6.15

@ShimShtein
Copy link
Contributor

Finally all green

@apinnick
Copy link
Contributor Author

apinnick commented May 5, 2024

Finally all green

@ShimShtein Thanks!

I tried to figure out the problem on my own but didn't succeed. :-(

@evgeni evgeni merged commit b6ee897 into RedHatSatellite:develop May 6, 2024
29 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Shortened guide titles need link updates in code for Sat
4 participants