#169 Switching Fedora Docs to Antora — last weekend of July
Closed: Complete 2 years ago Opened 2 years ago by asamalik.

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.


Metadata Update from @jflory7:
- Issue assigned to asamalik
- Issue priority set to: normal (1-2 weeks) (was: awaiting triage)
- Issue set to the milestone: Fedora 29 (to Oct. 2018)
- Issue tagged with: blocked, docs

2 years ago

@asamalik Thanks for the update! This shouldn't be an issue for us. I'm marking the ticket as blocked and assigning it to you until the maintenance work is complete.

Reminder: We're starting the transition on Friday 27 July.

Updates about the overall progress will be appearing in the main tracking issue: https://pagure.io/fedora-docs/docs-fp-o/issue/77

@asamalik Thanks! We are ready. :smile:

Seeing as this is now done, I am closing the ticket as complete.

Metadata Update from @jflory7:
- Issue untagged with: blocked
- Issue close_status updated to: Complete
- Issue status updated to: Closed (was: Open)

2 years ago

Login to comment on this ticket.

Metadata