Skip to content

Commit

Permalink
refs #232 copilot procedure and readme improvements (#233)
Browse files Browse the repository at this point in the history
* refs #232: Copilot subscription request has now specific steps.

* refs #232: README specifies better the contribution process. Trello is not longer used.
  • Loading branch information
mgdesign authored Jan 31, 2025
1 parent 868b290 commit 86d5052
Show file tree
Hide file tree
Showing 2 changed files with 45 additions and 20 deletions.
60 changes: 41 additions & 19 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,20 +1,46 @@
## SparkFabrik playbook
# SparkFabrik playbook

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
## Signaling issues or improvement

To keep things simple, we are using the issues in this project 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 this project so that the commits can reference it.

## Contribute

The project was meant to be internal and all company members can clone the project and set up a local environment issuing `make`.
After doing so, a local instance of the playbook will be available at `http://playbook.sparkfabrik.loc`.

To contribute you will need to open a pull-request towards the `master` branch of the project by referencing an open issue.
If you are willing to contribute content that is not covered by any open issue, you are invited to open one yourself, clarifying the nature of your contribution.

Please refer to the following sections the naming convention to the adopted on branches and pull requests.

### Pull request and commits naming convention:

Both commits and pull request titles should incorporate the issue number as so:

`refs #%%%: Title of the issue / commit message`

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`.
eg.

To contribute provide pull-requests towards `master` branch. The naming convention for the branches is:
* `refs #232: Copilot subscription request update`
* `refs #232: README now mentions the procedures to open a PR`

* `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
* `recipe/recipe-slug-title` for new recipes
### Branch naming convention:

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.
Branch naming is based on the nature of the contribution, and should always mention the issue number, following these examples:

* `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
* `recipe/%%%-recipe-slug-title` for new recipes
* `feature/%%%-feature-addition` for new features added to the playbook as a tool such as theme improvements, new plugins, etc

eg.

`git checkout -b content/232-copilot-procedure-and-readme-improvements`

## Guides

### Hide pages from home and menu

Expand All @@ -24,16 +50,15 @@ You can do so using the following options:
- `ShowOnMenu: false` will hide the page from the site menu
- `ShowOnHome: false` will hide the page from the home menu

## Theme
### Public assets placement

**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.
**Raneto** will search for public files to be included in the pages starting from the active theme `public` folder, and then proceeding 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 `public` inside the `spark-playbook` theme 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.

## Theme development
### Theme development

You can edit the `spark-playbook` theme in the `custom/themes/` folder.

Expand All @@ -45,17 +70,13 @@ Run `make theme-install-dep` to install all the dependencies needed to work on t

> 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 `DockerFile` of the project for more details on this.
## 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.

## What's inside

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
* A person in search for a procedure or information on how to perform a non-frequent task, such as manually launching 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

## What's NOT inside (and should never be)
Expand All @@ -66,7 +87,8 @@ It may surely contain links to internal resources as long as they are not public

## Why

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.
SparkFabrik grew a lot in its first year and it's now time to have a clear 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.

## Ownership
Expand Down
5 changes: 4 additions & 1 deletion content/tools-and-policies/github-copilot.md
Original file line number Diff line number Diff line change
Expand Up @@ -45,7 +45,10 @@ Purpose: This policy aims to establish guidelines for using GitHub Copilot withi

## How to request a subscription

You should have been granted a GitHub Copilot subscription during your onboarding. If that's not the case, you can ask an HR representative for a subscription. You will be requested to confirm that you have read and understood this usage policy
You should have been granted a GitHub Copilot subscription during your onboarding. If that's not the case, you can apply by doing as follows:
- on the [Github Copilot page](https://github.com/features/copilot), locate the section **Get Copilot from an organization**
- use the action **Ask admin for access** on the **SparkFabrik** organization
- ask an HR representative for a confirmation using the channel `#support-hr`

As the subscription will be made through our Github Organization, your already existing Copilot subscriptions (if any on the same account) will be automatically cancelled and reimbursed from Github, you’ll be informed in any case of the new activated subscription.

Expand Down

0 comments on commit 86d5052

Please sign in to comment.