Previewing and editing the handbook on your local computer is the easiest way to make changes, while knowing that they will look like you intend when you submit the merge request.
Where to get help
Everyone in the dev team is highly familiar with how to use Git, Editor and Merge Requests so you can ask anyone of them for help.
- Clone the repository from https://gitlab.com/timezynk/handbook
- The handbook is built using hugo. Install it by following the steps in Installing Hugo
- Open the folder in your favorite editor, for example https://code.visualstudio.com/
- Start hugo by running
- Make some changes! The format is Markdown and you can read more about the syntax at https://commonmark.org/help/
- You can now view your changes live at http://localhost:1313/handbook/
- Open a new branch for your edits
git checkout -b <branchname>. The branchname needs to be a single word, possible separated with hyphens, for example
- Check for new files and add them if necessary
- Commit your changes
git commit -am "Proposal for improved sales process"
- Push the branch
- The message from the push will give you a link you can use to create a merge request. Otherwise create one manually
Ping the #general slack channel or the CEO directly to have your changes reviewed and accepted.
Editing handbook in browser
Create new page
- Go to https://gitlab.com/timezynk/handbook
- Click button “Web IDE”
- Go to folder “content” -> “page” -> Choose the folder for the department that best suits your new entry
- Add new file (+) to chosen folder. Name the file with lower letters and _ instead of space. Add .md to ending (my_new_file.md), do not choose a template.
- Add message about what file you added and commit
Edit your page.
- Check (and steal) styling from other pages or this tutorial, do your stuff.
- Take a look at the tab “Preview Markdown” to see that everything looks good.
Add page to Index
- Go to /content/_index.md/
- Add name and link to your new page under the department you created your file in.
- Make sure you’ve made all changes you want to before you commit. Avoid making several commits in a row.
- Press “Create commit…” and add a message of the chances you’ve made, then commit changes to new branch.
- Ping the #general slack channel or the CEO directly to have your changes reviewed and accepted.