Clone the repository
$ git clone https://github.com/eea/eea.docker.githubdocs
$ cd eea.docker.githubdocs
During the first time deployement, create and edit the .gitconfig and the id_rsa files
$ docker run -it --rm -v $(pwd)/id_rsa:/root/.ssh/id_rsa eeacms/githubdocs --repo "https://api.github.com/orgs/eea" --skip "bise githubdocs ^docs$"
$ docker-compose run --rm app https://github.com/collective/<package name>
$ docker-compose run --rm app https://github.com/collective/<package name1> https://github.com/collective/<package name2>
$ docker-compose run --rm app `cat whitelist`
Variable | Description | Default value |
MENU_FILE | File which contains the specification of the right menu | _data/menu.yml |
LANDING_FILE | The readme where the list of available packages is displayed | IT-systems/index.md |
DOCS_LOCATION | The folder where the readme files for packages will be added | IT-systems |
MENU_BASE | The prefix what we should add to the links to the readme files | /IT-systems/ |
MENU_BASE_NAME | The name of the menu item in the menu.yml which should contain the subitems for the packages | IT-systems |
PLACEHOLDER_START | After this marker we add the list of the packages | <div style="display:none" class="generated_start"> |
PLACEHOLDER_END | Before this marker we add the list of the packages | <div style="display:none" class="generated_end"></div> |
PACKAGE_FOLDER_NAME | The location where to clone the gir repo of the github docs | docs |
PACKAGE_GIT_URL | The git link to the github docs | [email protected]:eea/docs.git |
PACKAGE_GIT_BRANCH | The branch where we want to make the commit | gh-pages |
SSH_KEY | Provide the private SSH key as environment variable |
The Initial Owner of the Original Code is European Environment Agency (EEA). All Rights Reserved.
The Original Code is free software; you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation; either version 2 of the License, or (at your option) any later version.