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:
To test your changes, first install asciibinder
$ sudo dnf install ruby-devel $ 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:
git
and asciibinder
.
$ gem install ascii_binder $ sudo dnf install git
$ git clone ssh://git@pagure.io/fedora-docs/docs-fp-o.git $ git clone ssh://git@pagure.io/fedora-docs/fedora-docs-web.git
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
$ ./builder.sh
This will generate a whole lot of output.
$ asciibinder package
This will also generate a lot of output.
$ 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.
$ git checkout prod $ git merge stg $ git push
In each content repository (i.e. https://pagure.io/fedora-docs/install-guide):
$ git checkout master
$ git checkout -b f27
$ vi en-US/entities.adoc
$ git add en-US/entities.adoc $ git commit -m "Branching for F27" $ git push upstream f27
$ git checkout master
$ vi _distro_map.yml
$ git add _distro_map.yml $ git commit -m "Branching for F27 - updating _distro_map.yml" $ git push upstream master
In this repo, the builder repository:
Note: In the build directory the beta version is always in the beta/
directory when published.
Edit the _distro_map.yml
to reflect the addition of the new version. See the fXX-en-US lines:
Edit builder.sh
to add the new branch to the BRANCHES variable
Edit build.sh
to add a new variable to hold the list of content repositories for the new branch. See f26_BOOKS for an example.
Edit the index-main.html
to link to the new version, as needed.
The asciibinder
command will incorrectly report that there are nonexistent topics in the _topic_map.yml
. This is error is caused by ruby's Find module not following symlinks and is specific to this build repository. To validate a specific content set, test it with asciibinder
in its source repository.
Add new features
builder.sh
as new functionality arrives in asciibinder