Skip to content

Latest commit

 

History

History
79 lines (57 loc) · 2.82 KB

README.md

File metadata and controls

79 lines (57 loc) · 2.82 KB
Raw

RedHatGov.io

Build Status

RedHatGov.io is a great open source collection of workshop materials that cover various topics relating to Red Hat's product portfolio.

Initial start towards developing

If you want to build RedHatGov.io right away:

  • You have a working Hugo environment - and probably at the correct version.

    • we keep a current working version in the ./bin/ folder

  • You have Ruby and the asciidoctor gem installed (yum install asciidoctor or gem install asciidoctor)

    $ git clone https://github.com/RedHatGov/redhatgov.github.io

    $ cd redhatgov.github.io

    $ hugo server

Building a working Hugo environment in a container

The following instructions for building a Hugo environment in a container have been tested on Fedora 32 with podman.

Grab the code and deploy the container as an unprivileged user:

git clone git@github.com:RedHatGov/redhatgov.github.io.git
cd redhatgov.github.io
podman run --rm -dt  -v $(pwd):/src:Z -p 1313:1313 docker.io/klakegg/hugo:asciidoctor server  --baseURL=http://example.com

Note: Please change the base URL to match the FQDN of your container host (example.com used above)

Enable the appropriate firewall port as root:

sudo -i
firewall-cmd --zone=FedoraServer --permanent --add-port=1313/tcp

Note: Change the firewall zone to what is required/defined on your host.

Access the web site as follows: https://example.com:1313 (replacing example.com with the FQDN of your container host)

Updating the site

Since travis CI is now dead, the site has to be updated manually. The process looks like this:

  1. make your updates, and send a PR to the docs branch, as in the past
  2. get peer approval/review and merge the changes to docs
  3. clone a new copy of the repository, and switch branch to master
    1. mkdir ~/src/master
    2. cd ~/src/master
    3. git clone git@github.com:RedHatGov/redhatgov.github.io.git
    4. git checkout master
  4. switch back to your original copy of the repository, on the docs branch, and build the site, using hugo and asciidoctor
    1. cd ~/src/redhatgo.github.io
    2. hugo --buildFuture --verbose
    3. cd public
    4. touch .nojekyll
    5. echo "redhatgov.io" > CNAME
  5. sync your changes to the master branch
    1. cd ~/src/master
    2. rsync -av /home/ajacocks/src/redhatgov.github.io/public/* .
    3. git add (list of all changes)
    4. git commit -m (comment on changes)
    5. git push

The site should now be updated. Do a force-refresh on your browser.

Contributing

If you have content that you'd like to contribute, check out our contribution guidelines for this project.