As many of you have probably noticed, together with bex and few other
people I work on moving the Fedora Docs to Antora. It has many technical
benefits as well as an active community. Talking about community, I want to
make sure that when the time comes and we're ready to push this thing to
production, our contributors are on board.
So I've just created a new epic: People! [1]
"The main reason we go through all this trouble is people. We want to make
it simple for people to contribute to the docs. And might not be a bad idea
to make sure our contributors are on board when we go crazy and push this
thing to production."
I'm looking for any useful input about making sure our contributors are on
board. I want this to be as smooth as possible.
My thinking is:
* Announce it here on this very list.
* Contact in advance every group having their docs on the site and:
** making sure we have converted their asciibinder source into the Antora
source right
** making sure they know how to make changes
* Do this over a few days, switching the Antora branches in all
repositories the site is built from to be the main branches. During these
few days, the current asciibinder site wouldn't update. All updates from
this period would end up on the new site. Basically, doing a few-days-log
freeze.
How does that sound? Anything I've missed?
Thanks!
Adam
[1]
https://taiga.fedorainfracloud.org/project/asamalik-antora-for-docs/epic/58
--
Adam Šamalík
---------------------------
Software Engineer
Red Hat
Dear all,
You are kindly invited to the meeting:
Docs Writing Hour on 2018-08-01 from 10:00:00 to 11:00:00 US/Eastern
The meeting will be about:
Join members of the docs team in #fedora-docs for writing time. This is a great time to focus on writing and talk about challenges and blockers related to producing content.
There is no formal schedule for this meeting. Attendees should show up and use this as a way to block writing time into their week.
Source: https://apps.fedoraproject.org/calendar/meeting/9195/
Hi everyone,
sometime within the next few days, the default assignee on all Bugzilla
components listed under the Fedora Documentation "product" will be
changed to myself. This shouldn't affect anyone too much, existing bugs
aren't affected by this, only new ones. See the issue[0] for some more
details.
As I said in one of the comments in the link, the long-term plan is for
me to check the ~200 currently open bugs, close ones that aren't
relevant anymore, migrate the ones that still are to Pagure issues, and
we'll close the whole BZ product and all its components to avoid
splitting reports between two tracking systems. That is unless someone
presents a really good case for keeping Bugzilla...
Cheers,
--
Petr Bokoč (pbokoc)
Senior Technical Writer
Community Platform Engineering
Red Hat Czech, s. r. o.
Purkyňova 99
612 45 Brno, Czech Republic
[0] https://pagure.io/fedora-infrastructure/issue/6615
Dear all,
You are kindly invited to the meeting:
Docs Writing Hour on 2018-07-25 from 10:00:00 to 11:00:00 US/Eastern
The meeting will be about:
Join members of the docs team in #fedora-docs for writing time. This is a great time to focus on writing and talk about challenges and blockers related to producing content.
There is no formal schedule for this meeting. Attendees should show up and use this as a way to block writing time into their week.
Source: https://apps.fedoraproject.org/calendar/meeting/9195/
Hey everyone!
Docs are being converted to a new build engine called Antora. A preview is
already available in staging at docs.stg.fedoraproject.org. Please note
that the design is still being finalized. We will switch the production
instance on 1 August 2018. To prepare we need to take several actions and
that includes asking you to merge some PRs that will reorganize your docs
repo to work with the new tool. Your content will not be modified. The
content will continue to be in AsciiDoc.
To accomplish this, we are requesting that you observe a freeze between
Friday 27 July and Sunday 29 July during which the following steps will be
done:
1. All existing content needs to be converted to the Antora structure (
https://pagure.io/fedora-docs/template/branch/antora) Someone from the
Docs team will send you a PR during the freeze.
2. Please don't modify your repository during the freeze. We encourage you
to merge any complete PRs before the freeze. PRs opened during the freeze
will need to be restructed to the new repository structure after the freeze
before they can be merged. The only PRs you should merge during the freeze
are the ones filed by the team converting your repo to Antora.
3. We will not be rebuilding the production site after the freeze starts
until 1 August. The stage site will be built to show the new builds so you
can check them after the freeze.
4. The site will be deployed to the stage instance,
docs.stg.fedoraproject.org.
5. At the end of the freeze, a confirmation will go out that contributions
can continue. Periodical rebuilds of the stage site will
continue. Production will get its first update on 1 August.
I will be available on IRC, Telegram, and email during the freeze for help.
Although I’m in Europe, I’ll do my best to be available even later in the
evening for our US-based contributors.
Please let me know if you have any questions.
Cheers!
Adam
--
Adam Šamalík
---------------------------
Software Engineer
Red Hat