Forked from fedora-docs/docs-fp-o 4 years ago

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 uses two repos:

You need git and asciibinder.

$ gem install ascii_binder $ sudo dnf install git
You need both repositories

$ git clone ssh://git@pagure.io/fedora-docs/docs-fp-o.git $ git clone ssh://git@pagure.io/fedora-docs/fedora-docs-web.git

Go to the docs-fp-o repository and ensure you are on master and that it is up-to-date

$ cd <path to docs-fp-o> $ git checkout master $ git pull
Prepare the repo to be built by loading in all documentation sources.

$ ./builder.sh

This will generate a whole lot of output.
Build the site

$ asciibinder package

This will also generate a lot of output.
Stage the site

$ cp -r _package/main/* <path to fedora-docs-web> $ cd <path to fedora-docs-web> $ git checkout stg $ git add . $ git commit -m "Updating site" $ git push
Review the staged site at docs.stg.fedoraproject.org and see if it looks good. The site is updated approximately every 5 minutes, so give it time.
If you're happy, push the changes to production.

$ git checkout prod $ git merge stg $ git push
Verify your changes have gone live at docs.fedoraproject.org and see if they look good. The production site is refreshed once per hour so this may take some time.

Add new features