Skip to content

docs: fix link to release train page #1373

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

Merged
merged 1 commit into from
Nov 21, 2024
Merged

docs: fix link to release train page #1373

merged 1 commit into from
Nov 21, 2024

Conversation

priteau
Copy link
Member

@priteau priteau commented Nov 13, 2024

No description provided.

@priteau priteau self-assigned this Nov 13, 2024
@priteau priteau requested a review from a team as a code owner November 13, 2024 11:03
@Alex-Welsh
Copy link
Member

The change looks good, but could you target it at stackhpc/2023.1?

@priteau
Copy link
Member Author

priteau commented Nov 13, 2024

The change looks good, but could you target it at stackhpc/2023.1?

It was initially committed to stackhpc/zed and made it to stackhpc/2023.1 via a merge, but not to stackhpc/2024.1, I don't know why.

@Alex-Welsh
Copy link
Member

The change looks good, but could you target it at stackhpc/2023.1?

It was initially committed to stackhpc/zed and made it to stackhpc/2023.1 via a merge, but not to stackhpc/2024.1, I don't know why.

I had assumed it wasn't because the 2023.1 version of the docs links to https://stackhpc-kayobe-config.readthedocs.io/en/stackhpc-2023.1/configuration/release-train which doesn't work, though you're right that the change is there.

@Alex-Welsh
Copy link
Member

Alex-Welsh commented Nov 13, 2024

The change looks good, but could you target it at stackhpc/2023.1?

It was initially committed to stackhpc/zed and made it to stackhpc/2023.1 via a merge, but not to stackhpc/2024.1, I don't know why.

I had assumed it wasn't because the 2023.1 version of the docs links to https://stackhpc-kayobe-config.readthedocs.io/en/stackhpc-2023.1/configuration/release-train which doesn't work, though you're right that the change is there.

I think the true fix should be to use a tag and link to that, the advantage there being that we can then rename the page and the link persists

For example:
tag: https://github.com/stackhpc/stackhpc-kayobe-config/blob/stackhpc/2024.1/doc/source/configuration/host-images.rst?plain=1#L1
link: https://github.com/stackhpc/stackhpc-kayobe-config/blob/stackhpc/2024.1/doc/source/configuration/lvm.rst?plain=1#L31

@priteau
Copy link
Member Author

priteau commented Nov 13, 2024

The change looks good, but could you target it at stackhpc/2023.1?

It was initially committed to stackhpc/zed and made it to stackhpc/2023.1 via a merge, but not to stackhpc/2024.1, I don't know why.

I had assumed it wasn't because the 2023.1 version of the docs links to https://stackhpc-kayobe-config.readthedocs.io/en/stackhpc-2023.1/configuration/release-train which doesn't work, though you're right that the change is there.

Good catch, it is missing the .html extension.

@Alex-Welsh Alex-Welsh added bug Something isn't working documentation Improvements or additions to documentation good first issue Good for newcomers antelope Targets the Antelope OpenStack release Caracal Targets the Caracal OpenStack release labels Nov 15, 2024
seunghun1ee
seunghun1ee previously approved these changes Nov 15, 2024
@seunghun1ee seunghun1ee self-requested a review November 15, 2024 14:26
@priteau priteau changed the base branch from stackhpc/2024.1 to stackhpc/zed November 20, 2024 22:19
@priteau priteau changed the title docs: fix link docs: fix link to release train page Nov 20, 2024
@priteau
Copy link
Member Author

priteau commented Nov 20, 2024

The change looks good, but could you target it at stackhpc/2023.1?

It was initially committed to stackhpc/zed and made it to stackhpc/2023.1 via a merge, but not to stackhpc/2024.1, I don't know why.

I had assumed it wasn't because the 2023.1 version of the docs links to https://stackhpc-kayobe-config.readthedocs.io/en/stackhpc-2023.1/configuration/release-train which doesn't work, though you're right that the change is there.

I think the true fix should be to use a tag and link to that, the advantage there being that we can then rename the page and the link persists

For example: tag: https://github.com/stackhpc/stackhpc-kayobe-config/blob/stackhpc/2024.1/doc/source/configuration/host-images.rst?plain=1#L1 link: https://github.com/stackhpc/stackhpc-kayobe-config/blob/stackhpc/2024.1/doc/source/configuration/lvm.rst?plain=1#L31

Good suggestion, thanks. I updated the change and targeted stackhpc/zed instead.

@Alex-Welsh Alex-Welsh enabled auto-merge November 21, 2024 12:46
@priteau priteau disabled auto-merge November 21, 2024 13:30
@priteau priteau merged commit 5e460b6 into stackhpc/zed Nov 21, 2024
@priteau priteau deleted the doc-fix branch November 21, 2024 13:30
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
antelope Targets the Antelope OpenStack release bug Something isn't working Caracal Targets the Caracal OpenStack release documentation Improvements or additions to documentation good first issue Good for newcomers
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants