This repository contains our company playbook (and possibly all the knowledge around our company-wide practices and policies), packed with a Raneto container to consult them.
So far the project is meant to be internal, all company members can clone the project and set up a local environment issuing make.
After that, a local instance of the playbook will be available at http://playbook.sparkfabrik.loc.
To contribute provide pull-requests towards master branch. The naming convention for the branches is:
section/section-slug-titlefor new sections (hardly they will be open by a company member, mostly it will be a matter of pre-made structure, but suggestions are welcome)content/description-of-the-contentfor content contributions of various nature, like typo corrections, adding a new procedure or policy, etcrecipe/recipe-slug-titlefor new recipes
A broad list of still-to-be-stubbed contents can be found on this Trello board (restricted access to the management board, so far): https://trello.com/b/uJMBxjZZ/sparkfabrik-playbook-and-documentation.
A new board will likely be spawned to act as a "parking lot" for changes to this playbook and to track the contents proposals and issues.
Using the metadata of the page, you have the option to hide it from the home menu or/and from the sidebar menu.
You can do so using the following options:
ShowOnMenu: falsewill hide the page from the site menuShowOnHome: falsewill hide the page from the home menu
Raneto will search for public files to be included in the pages starting from the active theme public folder, and then proceding to the folder configured as public_dir in the config.js file, currently the /assets folder of the project.
For this reason, this is how you should place anything you need to link inside the pages:
- content related assets should be placed in
/assets. Images, documents, attachments referenced in the markdown files should go here. - frontend related assets should be placed in
publicinside thespark-playbooktheme folder. Fonts, compiled css and js, any external libraries, favicon, etc should be placed here, as long as the images that are referenced in the css files.
You can edit the spark-playbook theme in the custom/themes/ folder.
Run make theme-install-dep to install all the dependencies needed to work on the theme.
make theme-watchwill trigger the watcher to allow you to work on the SCSS and JS files in the theme. At the end of watch lint task will be triggered.make theme-buildwill build the CSS & JS compiled in the theme folder for you.make theme-lint/make theme-lint-fixwill trigger the lint to allow you to check if SCSS are correctly written and auto fix them.
Please note that the docker image build will take care of the CSS & JS compiling for CI, Stage and Production, so you don't need to commit the compiled files. Check the
DockerFileof the project for more details on this.
To keep things simple, we'll use gitlab issues to keep track of all improvements or ideas we'll have. If you notice something that can be made better and want to either signal it to the authors or work it out by yourself, please, open an issue on gitlab so that the commits can reference it.
Basically this is the "SparkFabrik handbook". It is meant to be made public and contains all the information and recipes (hey) an employee has to know either before apply or during their everyday work.
You will get the major benefit if you are either:
- A newcomer, recent hire or in you onboarding phase, to learn a lot of information on how we do what we do, how we communicate and which principles drive our decisions
- A person in search for a procedure or information on how to perform a non-frequent task, such as manually lanching a build or reviewing an issue template
- In search for the correct policy to communicate something to someone or to share something in the right place
SparkFabrik playbook is a public document. Since the recipes and articles show how we actually do things internally and provide transparent information to the world, the content should be triple-checked not to contain credentials, secrets, customer-related information (screenshots of real issues for example), etc.
It may surely contain links to internal resources as long as they are not publicly available.
SparkFabrik grew a lot in its first year and it's now time to have a claer reference to either do stuff and take decisions.
This is a living document, not a carved-in-stone divine law. It will evolve as we evolve and try to represent our way of being.
To date, the owner of this document is Paolo Pustorino (paolo.pustorino@sparkfabrik.com) but any management representative or company shareholder with an active role in the company is entitled to manage the official version on his behalf.