GitBook Contributions
The documentation works in two different ways:
Handbookwhich contains all the documentation regarding all the island.is projects. You will find technical overview, architectural decisions, api, devops, code reviews, code standards detailed information and much more. If you need to edit an existing documentation or create a new page inside the handbook directory, you simply have to create amarkdownfile and start writing your content.README.mdwhich are all the readmes from theappsandlibsdirectories contained in the sub folders. The same goes for the README.md. Simply add your content using markdown. We only recommend one thing, is to use this template when you create a new app in theappsdirectory.
README.md files from directories inside the handbook/ directory are used to create the navigation structure when running the yarn gitbook command.You MUST create a
README.md with a H1 heading (example) — but apart from that, you may leave it empty and GitBook will automatically display the sub file structure.You need to use relative paths based on the current file location, might need a couple of
../../../ before finding the file you want to link to.We recommend adding an
assets folder inside the directory where you need it. You can then access your assets from your markdown file by doing ./assets/my-image.png.Once you are done with your changes, you will need to run the following command:
yarn gitbook
It will check for any new files created inside the
handbook directory or new README.md located inside the apps or libs directories and add it to the SUMMARY.md file, which is the file used by GitBook to create the navigation structure.The script will also format the README.md's title to follow the APA style convention. All files added the the
SUMMARY.md will be alphabetically ordered and organised in folders/sub-folders for the apps and libs.After your commit get merged into
main, it will take a few minutes before your changes appears on docs.devland.is.If you want to have a different title in the navigation than on the page itself, you can do so by adding a html comment like this to the top of your README.md:
<!-- gitbook-navigation: "Navigation Title" -->For some reason, if you don't want your markdown file to be part of the
SUMMARY.md file and included inside the GitBook, you can add the following html comment <!-- gitbook-ignore --> as the first line of the file.