aboutsummaryrefslogtreecommitdiff
diff options
context:
space:
mode:
Diffstat (limited to 'README.md')
-rw-r--r--README.md63
1 files changed, 57 insertions, 6 deletions
diff --git a/README.md b/README.md
index f730997..0210e84 100644
--- a/README.md
+++ b/README.md
@@ -1,4 +1,53 @@
-## Dependencies
+www.g.o
+---
+
+This repository is the home of www.gentoo.org.
+
+## Building the site
+
+### Using docker
+
+#### Automagic build and run
+
+From the root of the repository:
+
+`bash bin/docker-setup.sh jekyll build
+bash ./bin/update.sh
+bash bin/docker-setup.sh jekyll serve`
+
+#### Building and running manually
+
+Run the Dockerfile to build the container:
+
+`docker build --tag "wwwgo:Dockerfile" .`
+
+Once the container is built, run the container:
+
+`docker container run --name wwwgo --rm --mount type=bind,source="${PWD}",target=/srv/jekyll --publish=4000:4000 --env JEKYLL_UID="$(id -u)" --env JEKYLL_GID="$(id -g)" --interactive=true --tty=true wwwgo:Dockerfile jekyll serve`
+
+To removing all containers sourced from the wwwgo image:
+
+`docker ps --filter "ancestor=wwwgo" --all --quiet | xargs docker container rm`
+
+### Using bundler
+
+Ensure dev-ruby/bundler has been emerged:
+
+`# emerge -a dev-ruby/bundler`
+
+From the base of the installation directory run the following to get the dependencies:
+
+`bundler install`
+
+Then issue the following to start the jekyll server:
+
+`bundler exec jekyll serve`
+
+### Building the site natively (depreciated)
+
+This section has been depreciated due to certain ruby dependencies not being available in main Gentoo ebuild repository.
+
+### Dependencies
To get the dependencies on Gentoo systems using Portage:
@@ -10,18 +59,20 @@ To get the dependencies on Gentoo systems using Portage:
* dev-ruby/rbst - A Ruby wrapper for processing reStructuredText via Python's Docutils. This gem is required for GLEP generation (used by _plugins/gleps.rb).
* dev-ruby/base32 - A Ruby library for base32 decoding and encoding. This gem is required for OpenPGP keys (used by _plugins/wkd.rb).
-### Optional
+#### Optional
* net-misc/wget - Downloads files containing dynamic data (see below).
-## Dynamic data
+### Dynamic data
-Once the dependencies have been emerged, run `bash ./bin/update.sh` from this repository's base directory to update the site's data that is dynamically generated. Expect "LDAP user information" to be skipped on systems that are not directly connected to Gentoo's LDAP infrastructure.
+Once the dependencies have been emerged, run `bash ./bin/update.sh` from this repository's *base* directory to update the site's data that is dynamically generated. Expect "LDAP user information" to be skipped on systems that are not directly connected to Gentoo's LDAP infrastructure.
-## Generation
+### Generation
Issue a `jekyll serve` to build the site. Once the site builds it will (by default) be hosted at http://127.0.0.1:4000
+## Maintaining the site
+
## Posting news items
-Frontpage news item are built from the `_posts/` directory.
+Front page news item are built from the `_posts/` directory. The simple method is to copy and paste one of the recent news posts and then edit as necessary.