#98 Make Remix documentation more visible
Opened 2 years ago by tjzabel. Modified 2 years ago

The current Remix CI documentation is only reachable if you know the link to type in. There is no way to reach it by clicking through the docs.

This issue is also somewhat related to #81. It would be a good idea to figure out a central location for all Fedora Remix documentation to exist.


I wanted to add a link to the Remix CI docs, but I couldn't see it there. It is definitely not being built at the moment.

The reason why it's there is probably because it was being built in the past, but then deleted? And the publishing script doesn't delete old pages (I'll fix that).

So what's the next step? Do we want to add it back? If so, I'd need a git repo URL as I don't know where it was/is stored.

Well, I've just checked and the publishing script is OK. Checking the repo containing the published content [1] and I can't see it there. So it's very likely an error in the infra. I'll get that fixed.

[1] https://pagure.io/fedora-docs/fedora-docs-web/blob/prod/f/en-US

@asamalik the remix-ci pagure repo lives here if it helps: https://pagure.io/fedora-docs/remix-building/

Thanks for taking care of this so quickly! Quick question though: It looks like you are asking to delete the web page. This is not the desired result. I would like to have the documentation available, as it is still being actively developed. It was previously under the Quick Docs before the Antorra conversion. It may be a good idea to place it back in there for now.

In the near future, I would like to consolidate all Remix/spins documentation into one place.

@tjzabel I definitely don't want to remove it — I just used it as a [bad] example of a bug in the pipeline.

If you want to include it in the quick docs, you can just create a page in the existing quick docs repo: https://docs.fedoraproject.org/en-US/quick-docs/

Having a custom repo like this would give you your own space with your own menu. So it depends on what you want — I'm happy to do either.

@asamalik I would personally like to have a custom repo as a separate space. I think there are a lot of docs I could add in the future.

Login to comment on this ticket.

Metadata