docs December 2021

docs@lists.fedoraproject.org

11 participants
7 discussions

Issue with local antora docs environment
by Peter Boy 10 Jan '22

10 Jan '22

I just tried to start my local antora Fedora docs build environment and it failed: $ ./build.sh && ./preview.sh This build script is using Docker container runtime to run the build in an isolated environment. Unable to find image 'antora/antora:latest' locally latest: Pulling from antora/antora 97518928ae5f: Pull complete 16a1a5057866: Pull complete ad8b526cbb1f: Pull complete 0328e268dee9: Pull complete 189b546b5e76: Pull complete 9cb3f4115fdb: Pull complete f4dabaa8a81b: Pull complete Digest: sha256:caf0d59c92c292858d6569dc8a9f4b104f85743db2eaf55f34ef0a2c97a3ef90 Status: Downloaded newer image for antora/antora:latest [07:32:52.861] FATAL (antora): configuration param 'runtime.pull' not declared in the schema for /antora/site.yml (cwd: /antora, playbook: site.yml) Any idea what went wrong and how to fix it?

3 6

Project organisation
by Ryan Lerch 05 Jan '22

05 Jan '22

Promise this is the last thread i'll start til next week, but back on the docs train a little bit :) So, how does the team think about mixing up how the team works and communicates? im thinking two seperate ideas here: 1. Archive this mailing list and move discussion for docs over to discussion.fedoraproject.org 2. Clean up all the docs repos, and move them to gitlab (specifically gitlab.com/fedora/docs) -- obviously this is a big and contentious one, but it would allow us to have subgroups for our tooling and docs, making it easier to group this stuff out. Also the way gitlab shows all tickets for groups will allow us to see issues across all our docs repos, rather than following many many repos. cheers, ryanlerch

7 17

Antora docs down
by Ankur Sinha 26 Dec '21

26 Dec '21

Hiya, (Resending without attachments) I was looking for the package maintainer docs and hit a 404, and now when i go to docs.fp.o, i get the old publican docs. Are the antora docs down or is there an outage in progress (in any case we shouldnt automatically redirect to old docs here)? -- Thanks, Ankur (Sent from mobile device)

2 2

Repos, Branches, and themes confusing
by Ryan Lerch 16 Dec '21

16 Dec '21

Hi all, I recently jumped back into looking at docs, and took me quite a while to figure everything out, and just wondering if we could change things up a bit. follows are the things that i found confusing: 1. https://pagure.io/fedora-docs/docs-fp-o default branch is master, that hasnt been updated for two years -- should we make the default branch prod? (also the stage branch's readme still refers to https://pagure.io/fedora-docs/fedora-docs-web) 2. https://pagure.io/fedora-docs/fedora-docs-web still looks active, but it doesnt seem to be used anymore -- you don't need to push built results there, anymore right? Should this repo just be deleted, since it only ever housed built stuff anyway? 3. It took me ages to find where the static front pages were -- i finally found them at https://pagure.io/fedora-docs/pages/ but we really should update the docs docs with this information 4. Finally, the antora UI bundle -- it seems the UI bundle is being pulled from a zip on asalalik's fedora people -- and then we are adding additional changes via supplemental-ui in the docs-fp-o repo. Is there any reason we cannot merge these changes back into https://pagure.io/fedora-docs/fedora-docs-ui start doing numbered releases of these bundles, and hosting the built zips on gitlab or pagure, and pulling from there rather than fedorapeople? cheers, ryanlerch

5 8

QuickDocs inquiry
by Bill Cozens 16 Dec '21

16 Dec '21

Hey all, I'm new to docs (and Fedora in general) and I'm looking to get involved with Quick Docs. As it stands now, however, I feel like I lack the technical expertise to make a meaningful contribution to it. To that end I wanted to ask SMEs in the community if they would change anything in the Quick Docs - and from there, offering to translate their thoughts into documentation. Basically like an SME interview sort of thing. That being said, is anybody here willing/can anyone point me in the right direction to people who might be willing to do this sort of thing with me? Thanks a ton. - Bill

1 0

docs.fedoraproject.org front page suggestions
by Matthew Miller 14 Dec '21

14 Dec '21

Search is the leading problem, but I think we can probably clean up the navigation quite a bit. It just kind of ... grew this way. 1. Remove F34 and Rawhide bubbles. Let's just feature the latest. If we want older release docs to be more prominent, we can style the version-changer more prominently. 2. Definitely remove links to the really old docs, as previously discussed. 3. Having EPEL on the front page separately still seems good, considering the user base and that EPEL is one of the most popular queries leading to the site. 4. I'm unsure about front page bubbles, but -- I think we should put all of the Edition / spin documentation into one three-level hierarchy instead of lots of two-level ones. 5. I still kind of like "Fedora Project" as a little mini-site, but maybe _all_ of the rest of Fedora Council, Engineering Teams, Mindshare Teams, D&I, PgMT should be put into one? 6. Not sure where stuff like Gaming should go. 7. Packaging guidelines and to-be-added Legal... same. 8. Outreachy docs should be removed, since they're not on the docs site. 9. GCP should be removed because we're not doing that anymore. -- Matthew Miller <mattdm(a)fedoraproject.org> Fedora Project Leader

4 11

Add Fedora Gaming to docs.fedoraproject.org page
by Andrew Heath 07 Dec '21

07 Dec '21

All, I am writing to ask permission to add Fedora Gaming(https://docs.fedoraproject.org/en-US/gaming/) to the Fedora Docs page under the Fedora Project & Community section. I am following https://docs.fedoraproject.org/en-US/fedora-docs/contributing/adding-new-do… and want to make sure that I get permission before I start making changes.

3 6

2024

2023

2022

2021

2020

2019

2018

2017

2016

2015

2014

2013

2012

2011

2010

2009

2008

2007

2006

2005

2004

2003

2002

docs December 2021