Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

refs #56: Import jquery by webpack and reorganize js libraries #57

Closed
wants to merge 43 commits into from
Closed
Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
43 commits
Select commit Hold shift + click to select a range
090ec8b
Added a chapter on how we perform job interviews. (#16)
stickgrinder Jul 30, 2018
a1361c8
Better phrasing for an online WIP (#17)
stickgrinder Aug 28, 2018
393e3d1
The istruction by PaoloM have been ported to the playbook in a proper…
stickgrinder Aug 28, 2018
9e691d7
Small corrections to the recipe (#18)
stickgrinder Aug 29, 2018
49bf03b
Last corrections to k8s recipe
stickgrinder Aug 29, 2018
ae8f1bc
Added information about projects envs availability and troubleshooting
stickgrinder Sep 25, 2018
be1dcc2
Typo corrections
stickgrinder Sep 25, 2018
2ebc614
Add gcloud docker integration command
paolomainardi Nov 14, 2018
debb091
refs #000: edited macosx command and docker machine name (#20)
enricosato Nov 23, 2018
2302ae5
HR - Job roles and evaluation framework (beta) (#21)
stickgrinder Jan 22, 2019
2a6a58e
Added administrative role and related ISC
stickgrinder Jan 31, 2019
4eba88e
closes #23: Added a first version for the promo resources page.
stickgrinder Feb 1, 2019
22419c7
Update README (#26)
francescoben Feb 6, 2019
c7196be
Tracking policies page laid down (#29)
stickgrinder Apr 24, 2019
5da1158
Fix for the manifiesto link (#30)
juanebarreira Jun 6, 2019
52f3910
Recipe: OpenVPN Ubuntu NetworkManager (#31)
edodusi Jun 18, 2019
7e97a80
Add instructions to upgrade to openvpn 2.4
paolomainardi Jun 18, 2019
4804d4e
WIP: employee onboarding process (#32)
stickgrinder Jul 9, 2019
8faa03e
Career advancement link (#34)
francescoben Jul 9, 2019
b3099cd
Fixed typos
stickgrinder Jul 16, 2019
8b9aebf
Merge branch 'master' of github.com:sparkfabrik/company-playbook
stickgrinder Jul 16, 2019
a67f56d
Added line related to project mail groups (#36)
stickgrinder Jul 18, 2019
b856d50
Configuration is now updated to support Lunr 2.0 in Raneto 0.16.2 (#37)
stickgrinder Jul 18, 2019
b2fd1a4
Content reorganization, improved readability (#38)
stickgrinder Jul 24, 2019
37a2405
Link to ISCs is now working (thanks Christian) (#39)
stickgrinder Jul 24, 2019
2217f1d
Hiring from abroad (#40)
stickgrinder Jul 31, 2019
5e414d5
Information addition to hiring from abroad page
stickgrinder Jul 31, 2019
c6ef07e
Typo correction
stickgrinder Jul 31, 2019
f1c4d94
the update openvpn must be done as sudo
MarianoFranzese Jul 15, 2019
2db0698
Merge pull request #35 from sparkfabrik/recipe/openvpn-ubuntu-network…
edodusi Aug 5, 2019
15e5d2b
Use redis image for testing dnsdock: non need to login into sparkfabr…
alessiopiazza Sep 7, 2019
7ae7344
Added link to the printable document for ISCs
stickgrinder Nov 21, 2019
4b29a9f
Printable ISCs (#47)
francescoben Feb 13, 2020
ed4d5bd
refs #48: add new sparktheme design
May 7, 2020
17a0f95
refs #48: enable home.html by removing index.md, original content in …
May 7, 2020
9c3a603
refs #48: add meta files for description categories
May 7, 2020
d8e98be
refs #48: update makefile to install npm dep
May 7, 2020
1340cd7
refs #48: publish lib
May 12, 2020
d550018
refs #51: added OG/Twitter metatags
May 12, 2020
500f7fe
res #51: add current_url variables
May 13, 2020
8735b7c
refs #51: fixed Dokerfile
May 13, 2020
dd6c56a
refs #54: changed icon's link to playbook, added link to corporate si…
May 19, 2020
dee7743
refs #56: Import jquery by webpack and reorganize js libraries
May 21, 2020
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 4 additions & 0 deletions .gitignore
Original file line number Diff line number Diff line change
@@ -0,0 +1,4 @@
.DS_Store
**/public/dist/
node_modules/
*.log
20 changes: 18 additions & 2 deletions Dockerfile
Original file line number Diff line number Diff line change
@@ -1,11 +1,27 @@
FROM sparkfabrik/docker-locke-server:latest
MAINTAINER Paolo Pustorino <paolo.pustorino@sparkfabrik.com>
LABEL author="Paolo Pustorino <paolo.pustorino@sparkfabrik.com>"

# Remove content folder
RUN rm -rf content/

# Copy content and configuration
COPY ./custom/config.js /srv/locke/config.js
COPY ./custom/custom-styles.css /srv/locke/themes/spark/public/styles/custom.css
COPY ./custom/themes /srv/locke/themes
COPY ./content /srv/locke/content
COPY ./assets /srv/locke/assets

# This file copy is a simple and effective way
# to enchance RANETO waiting for the pull request
# in the project to be accepted.
COPY ./custom/raneto/contents.js /srv/locke/node_modules/raneto/app/core/contents.js
COPY ./custom/raneto/wildcard.route.js /srv/locke/node_modules/raneto/app/routes/wildcard.route.js
COPY ./custom/raneto/home.route.js /srv/locke/node_modules/raneto/app/routes/home.route.js

WORKDIR /srv/locke/themes/spark-playbook

RUN \
npm update && \
npm install && \
npm run build

WORKDIR /srv/locke/
24 changes: 24 additions & 0 deletions Makefile
Original file line number Diff line number Diff line change
@@ -1,3 +1,27 @@
up:
docker-compose pull
docker-compose up -d

cli:
docker-compose run --rm documentation bash

# Sparkkit based themes specific commands.
theme-watch:
chmod +x bin/npm
bin/npm run watch

theme-build:
chmod +x bin/npm
bin/npm run build

theme-scss-lint:
chmod +x bin/npm
bin/npm run scss-lint

theme-scss-lint-fix:
chmod +x bin/npm
bin/npm run scss-lint-fix

theme-install-dep:
chmod +x bin/npm
bin/npm install
25 changes: 20 additions & 5 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,12 +1,13 @@
## SparkFabrik dockerized Raneto-based playbook
## SparkFabrik playbook

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.
Ideal destination for this stuff is on a domain like **playbook.sparkfabrik.com**. So far you can `docker-compose up -d` and visit http://playbook.sparkfabrik.loc to enjoy the result.
This repository contains our [company playbook](https://playbook.sparkfabrik.com) (and possibly all the knowledge around our company-wide practices and policies), packed with a Raneto container to consult them.

## Contributions

So far the project is meant to be internal. All company members can download the project and provide merge-requests towards `master` branch.
The naming convention for the branches is:
So far the project is meant to be internal, all company members can clone the project and set up a local environment with the command `docker-compose up -d`.
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-title` for 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-content` for content contributions of various nature, like typo corrections, adding a new procedure or policy, etc
Expand All @@ -15,6 +16,20 @@ The naming convention for the branches is:
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.

## Theme

You can edit the `spark-playbook` theme in the `custom/themes/` to match the styles and settings of your new project, you won't need to change the machine name of the theme.

`make theme-install-dep` will install all the dependencies in the theme folder for you.

`make theme-build` will build the CSS & JS compiled in the theme folder for you.

`make theme-watch` will trigger the watcher to allow you to work on the SCSS files in the theme. At the end of watch lint task will be triggered.

`make theme-lint` / `make theme-lint-fix` will trigger the lint to allow you to check if SCSS are correctly written and auto fix them.

The PHP docker image will take care of the CSS & JS compiling for CI, Stage and Production, so you don't need to commit the compiled files.

## Signaling issues or improvement

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.
Expand Down
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added assets/images/procedures/nm-allusers.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added assets/images/procedures/nm-openvpn-select.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added assets/images/procedures/nm-select.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added assets/images/procedures/nm-vpn-connected.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file not shown.
Binary file not shown.
12 changes: 12 additions & 0 deletions bin/npm
Original file line number Diff line number Diff line change
@@ -0,0 +1,12 @@
#!/usr/bin/env bash
set -e
QUOTEDCMD=()
for token in "$@"; do
QUOTEDCMD+=($(printf "%q" "$token"))
done
CMD="${QUOTEDCMD[*]}"
if [ -z "$CMD" ]
then
CMD="version"
fi
docker-compose run -w "/srv/locke/themes/spark-playbook" --rm documentation npm ${CMD}
2 changes: 1 addition & 1 deletion content/FAQ/can-i-have.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@
Yes. We have budgets for Linux PCs, Apple machines, PHPStorm licenses and some more gizmos that you may need.

Other than that, if you need a device or license to speed up your work, just ask your team leader and we'll evaluate case by case.
On standard hardware and software, please read [this section](/our-company/approved-hardware-and-software) to learn more.
On standard hardware and software, please read [this section](/tools-and-polices/approved-hardware-and-software) to learn more.

### Books

Expand Down
1 change: 1 addition & 0 deletions content/FAQ/meta
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
description: very helpful to newcomers, but also to veterans that want to refresh their minds.
2 changes: 1 addition & 1 deletion content/FAQ/sort
Original file line number Diff line number Diff line change
@@ -1 +1 @@
50
60
41 changes: 41 additions & 0 deletions content/_index.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,41 @@
/*
title: SparkFabrik playbook
*/

What you are reading is the _manual_ of our company.
As every organization we have rules, policies, practices, processes and procedures and these pages are primarly meant as a clear reference for our workforce, so that nobody gets lost during everyday work.

But at the same time, this is our effort to be transparent, clear and fair to anyone so that the way we work may be followed, discussed and evolved even by people outside the organization.

Many useful information can be found here about how SparkFabrik works and we also value contributions and feedback, so don't be shy.

## Playbook sections

This playbook is organized into the following sections:

* **Organization**: how we are structured, which functional roles are recognized in the company, their responsibilities and company's expectations.
* **Working at SparkFabrik**: how we hire, pay, evaluate, reward and listen to our workforce.
* **Tools and policies**: pretty much as it sounds, learn here about our rules and what the company provides to follow them.
* **Procedures**: best practices for specific tasks; our procedures evolve and adapt over time but at any moment, you can find them here.
* **Guides**: how to do things the best way; guides differ from procedures in that they are descriptive, not prescriptive.
* **Resources**: find here those important things you may need every now and then.
* **FAQ**: very helpful to newcomers, but also to veterans that want to refresh their minds.

## Credits

This playbook and many company practices have been heavily inspired by [Deeson](https://www.deeson.co.uk/), so many thanks go to that nice guy.

Our practices owe a great tribute to the guys at [StackOverflow](https://stackoverflow.com/).

We learned to value transparency as a propeller to innovation dwelling in [Agile](https://agilemanifesto.org/) and [FOSS](https://www.fsf.org/) culture.

This Playbook is powered by a small and effective piece of free software called [Raneto](http://raneto.com/), one of the best choice for minimum effort knowledgebase keeping.

## Feedback and contributions

You can find the source of these pages on [GitHub](https://github.com/sparkfabrik/company-playbook).
You can file issues, fork the project and send PRs.

## License

<a rel="license" href="http://creativecommons.org/licenses/by-sa/4.0/"><img alt="Creative Commons License" style="border-width:0" src="https://i.creativecommons.org/l/by-sa/4.0/88x31.png" /></a><br /><span xmlns:dct="http://purl.org/dc/terms/" property="dct:title">SparkFabrik Playbook</span> by <a xmlns:cc="http://creativecommons.org/ns#" href="https://www.sparkfabrik.com" property="cc:attributionName" rel="cc:attributionURL">Sparkfabrik Srl</a> is distributed under <a rel="license" href="http://creativecommons.org/licenses/by-sa/4.0/">Creative Commons Attribution - Sharealike 4.0 International</a> license.
Loading