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
$ 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.
In each content repository (i.e. https://pagure.io/fedora-docs/install-guide):
Go to the master branch
$ git checkout master
Branch for the new release, Fedora 27 in this example:
$ git checkout -b f27
Update the entities file to reflect the correct version numbers
$ vi en-US/entities.adoc
Commit your changes and push to the upstream repository
$ git add en-US/entities.adoc
$ git commit -m "Branching for F27"
$ git push upstream f27
Return to the master branch
$ git checkout master
Update the _distro_map.yml file to add the new version
$ vi _distro_map.yml
Commit your changes and push to the upstream repository
$ 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.
Add new features
builder.sh
as new functionality arrives in asciibinder