#28 The https://pagure.io/fedora-docs/quick-docs/ repo does not have ROOT/partials.
Opened by adelton. Modified
fedora-docs/ adelton/documentation-contributors-guide partials  into  master

Download 28.patch
no initial comment

Hi @adelton, thanks for opening this. This change raises a good question about how we document this deprecated convention. Technically, this is a bug that should be fixed in downstream repositories. Here are my two ideas:

  1. Don't add this to the docs, but instead open a tracker ticket for repositories that need updating. Fedora Docs team members can help less experienced docs writers get set up on the new way of importing partials.
  2. Keep this note here, but add a sentence noting this is a deprecated setup in Antora and might break unexpectedly in the future. We want to encourage people to update this method since it will break in Antora eventually.

What do you think @adelton?

Metadata Update from @jflory7:
- Pull-request tagged with: type - existing docs
- Request assigned

I have no idea. I was just trying to figure out where https://pagure.io/fedora-docs/quick-docs/pull-request/288 should be fixed, I found https://docs.fedoraproject.org/en-US/fedora-docs/asciidoc-fedora/reusable-attributes/, and I noticed that the location does not match. I don't know which location is the deprecated one and which one is the "correct" one.

My $0.0175 (darn deflation): If fedora-docs sites are still using modules/ROOT/pages/_partials/attributes.adoc, then the new convention has not been disseminated nearly far and wide enough to ignore the old convention in the docs, as the old convention is probably more likely to be encountered "in the wild", for the time being.

And, also, It's probably a good idea to update https://pagure.io/fedora-docs/quick-docs/ so it's no longer using the outdated path. I don't see a pull request or even an issue open, currently, for the move from ROOT/pages/_partials/ to ROOT/partials/.

(I can file one, but are we sure they're using an Antora version that supports ROOT/partials/? How recently was support for the new path added?)

Ah, ignore that last question, I see from @jflory7 's commit updating the doc in question that

Recently I needed to create reusable attributes in a docs
project with multiple modules (a.k.a. this repo). So, while digging, I
discovered that the way I learned to include partials is deprecated
since Antora 1.1. The current stable version is 2.3.4 and an early alpha
is released for v3.0.0.

So, yeah, the quick-docs site should probably be brought up to code, as it were.

Metadata