PR#303: docs: make it an unversioned component - fedora-commops

fedora-commops

#303 docs: make it an unversioned component

Merged 6 months ago by jflory7. Opened 2 years ago by darknao.

darknao/fedora-commops main into main

docs: make it an unversioned component

Francois Andrieu • 6 months ago

46e4f0a

docs/antora.yml

file modified

+1 -1

		`@@ -6,7 +6,7 @@`
		`title: CommOps`

		`# If you don't plan to have multiple versions of the docs (for example, to document multiple versions of some software), you can ignore this field. Otherwise, change "master" to a specific version.`
		`- version: main`
		`+ version: ~`

		`# We encourage you to name the index page as "index.adoc". If you absolutely have to use a different name, please reflect it here. You can ignore this field otherwise.`
		`start_page: ROOT:index`

darknao commented 2 years ago

I noticed your documentation is available on docs.fedoraproject.org/en-US/commops /latest/
If this is expected, then please disregard this PR.
If it's not, then please continue reading :)

Until now, Antora was using the value master as a keyword for unversioned components. This is now deprecated, and the right way to remove the version from a component with Antora 3 is by setting the version key to ~ (or null).
After that, your documentation module will be accessible at https://docs.fedoraproject.org/en-US/commops/ (without the /latest/ part)

rebased onto 46e4f0a

6 months ago

Metadata Update from @jflory7:
- Pull-request tagged with: team - commops, type - docs
- Request assigned

6 months ago

jflory7 commented 6 months ago

I rebased this PR on the latest changes in main. Since the PR is over a year old, I also checked in with @darknao on #docs:fedoraproject.org about this change. There will be some URL breakage, but using the unversioned component is what we actually want to do here. I am going to merge this, and I will also ping the CommOps room about this change to raise awareness about the breakage.

Merging! Thanks @darknao for bringing this to our attention. :clapper:

Pull-Request has been merged by jflory7

6 months ago