README.md

AsciiBinder-Based Fedora Docs Publishing Repo

This is the build repository for the Fedora Documentation Website

Please report Issues and submit Pull Requests for Publishing Fixes here. Content issues be reported against the source repositories:

Testing your changes locally

To test your changes, first install asciibinder

$ gem install ascii_binder

To build your changes, from the root directory:

$ asciibinder package
$ ./builder.sh
$ firefox _package/main/index.html

Publishing Notes

Project Plan

  1. Review the built output with a goal of getting the initial site ready to be published ASAP. We are here

  2. Enable publishing of this site by doing the following.

    1. Republish the existing docs.fedoraproject.org one last time to html while removing the F26 content.
    2. Establish docs-old.fedoraproject.org (or a similar url) and publish the content for F25 and before one last time.
    3. Modify the built output repository for asciibinder to have both a prod and stg branches.
    4. Remap docs.fedoraproject.org and docs.stg.fedoraproject.org to use the asciibinder built output repository.
  3. Add new features

    • remove builder.sh as new functionality arrives in asciibinder
    • Translations
    • Search
    • CI/CD for automatic publishing and rebuild
    • CI/CD for branch and topic publishing and rebuild
    • ???