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

chore: docs: Add more aliases for ++version++ to current #3212

Merged
merged 1 commit into from
Oct 16, 2024

Conversation

martin-g
Copy link
Member

Reported at apache/avro-rs#22
Discussed at apache/avro-rs#20 (comment)

What is the purpose of the change

  • Add more aliases from ++version++ to current in the Hugo based docs

Verifying this change

Documentation

  • Does this pull request introduce a new feature? no
  • If yes, how is the feature documented? not applicable

Reported at apache/avro-rs#22
Discussed at apache/avro-rs#20 (comment)

Signed-off-by: Martin Tzvetanov Grigorov <mgrigorov@apache.org>
@KalleOlaviNiemitalo
Copy link
Contributor

When 1.13.0 is released, will doc/content/en/docs/++version++/ be copied to doc/content/en/docs/1.13.0/? Will the current aliases have to be deleted from doc/content/en/docs/1.13.0/ at that time?

@martin-g
Copy link
Member Author

Will the current aliases have to be deleted from doc/content/en/docs/1.13.0/ at that time?

Yes! They will have to be deleted.

@KalleOlaviNiemitalo
Copy link
Contributor

The copying and deletion might be worth documenting in the "New release" section of doc/README.md. But I see it's not a new omission as there's already a similar alias since AVRO-4041 commit ea17b9d:

aliases:
- /docs/current/

@martin-g
Copy link
Member Author

The copying and deletion might be worth documenting in the "New release" section of doc/README.md.

Please send a PR!

But I see it's not a new omission as there's already a similar alias since AVRO-4041 commit ea17b9d:

I am still learning how Hugo works. I thought that the previous commit will cover all requests to /docs/current/** but it seems it does not. So, we have to cover each and every path manually ...

@martin-g
Copy link
Member Author

IMO the best would be to rename ++version++ to something nicer, like snapshot.
But this itself will need aliasing to prevent 404 links ...

@martin-g martin-g merged commit 8baf9de into main Oct 16, 2024
2 checks passed
@martin-g martin-g deleted the avro-rs-issue-22 branch October 16, 2024 05:59
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants