tildes-issue-log/README.md

# Tildes Issue Log

## 2018

* [May](https://til.bauke.xyz/posts/may-2018.html)
* [June](https://til.bauke.xyz/posts/june-2018.html)

## Contributing

If you'd like to write a highlight section about a feature, please do! I'm not a writer by any means and would love to have other people write these instead. If you're not familiar with the Git workflow you can always [private message me](https://tildes.net/user/Bauke/new_message) with what you've written and I'll add your section for you, crediting your Tildes profile. If you'd like to learn Git, you can find tons of guides online. [Here's](https://try.github.io/) an excellent one.

## Building

If you'd like to build the issue table, statistics and/or website yourself you can follow these steps.

You'll need [Node JS](https://nodejs.org/) and [Yarn](https://yarnpkg.com/). You *can* use NPM however I don't. You probably know what you're doing though at that point.

* Clone the repository
  * SSH: `git clone git@gitlab.com:Bauke/tildes-issue-log.git`
  * HTTPS: `git clone https://gitlab.com/Bauke/tildes-issue-log.git`
* Change into the directory: `cd tildes-issue-log`
* Install the dependencies: `yarn`
* Create a `config.json` file from the sample config, including a [personal access token](https://docs.gitlab.com/ee/user/profile/personal_access_tokens.html) from GitLab. **config.json is gitignored however make sure you don't publish your token somewhere on accident.**
* Run `yarn dl` to download the issues from the current month we're in and build the statistics and issue table, if you already have the issue files you can run `yarn nodl` to skip the downloading
* To easily develop the website itself you can run `yarn watch` to watch the `src/` folder for changes and automatically lint the sass and build the files. Running `yarn watch` will open your default browser at `localhost:3000`.
* To build the site only once you can do `yarn build`, the files will be built under `public/`, a requirement for GitLab Pages.

A new gitignored directory will be created like `data/2018/August` and have 2 folders and 2 [Pug](https://pugjs.org) files.

The folders are for issues both opened or closed during that month `table.pug` will be the issue table and `statistics.pug` will be the statistics.

If you're working on the generation process you can run `yarn nodl` to skip the downloading phase, this will only generate `table.pug` and `statistics.pug`. This way you don't have to wait several seconds for the GitLab API to respond.

If you want to lint your sass (using [Stylelint](https://stylelint.io/)) manually you can run `yarn lint:sass`, in the future when we have JavaScript (if ever) there will also be a `yarn lint:js` task and a general task `yarn lint` however as there's 0 JS at the moment there's no need for JS linting.
Initial commit with May entry 2018-06-24 16:38:50 +00:00			`# Tildes Issue Log`

			`## 2018`

Massive change from Markdown to custom website with Pug & Sass 2018-07-16 01:29:01 +00:00			`* [May](https://til.bauke.xyz/posts/may-2018.html)`
			`* [June](https://til.bauke.xyz/posts/june-2018.html)`
Initial commit with May entry 2018-06-24 16:38:50 +00:00
Add contributing and building sections to README 2018-06-24 22:56:52 +00:00			`## Contributing`

			`If you'd like to write a highlight section about a feature, please do! I'm not a writer by any means and would love to have other people write these instead. If you're not familiar with the Git workflow you can always [private message me](https://tildes.net/user/Bauke/new_message) with what you've written and I'll add your section for you, crediting your Tildes profile. If you'd like to learn Git, you can find tons of guides online. [Here's](https://try.github.io/) an excellent one.`

Initial commit with May entry 2018-06-24 16:38:50 +00:00			`## Building`

Massive change from Markdown to custom website with Pug & Sass 2018-07-16 01:29:01 +00:00			`If you'd like to build the issue table, statistics and/or website yourself you can follow these steps.`
Add contributing and building sections to README 2018-06-24 22:56:52 +00:00
			`You'll need [Node JS](https://nodejs.org/) and [Yarn](https://yarnpkg.com/). You can use NPM however I don't. You probably know what you're doing though at that point.`

			`* Clone the repository`
			* SSH: `git clone git@gitlab.com:Bauke/tildes-issue-log.git`
			* HTTPS: `git clone https://gitlab.com/Bauke/tildes-issue-log.git`
			* Change into the directory: `cd tildes-issue-log`
			* Install the dependencies: `yarn`
			* Create a `config.json` file from the sample config, including a [personal access token](https://docs.gitlab.com/ee/user/profile/personal_access_tokens.html) from GitLab. config.json is gitignored however make sure you don't publish your token somewhere on accident.
Massive change from Markdown to custom website with Pug & Sass 2018-07-16 01:29:01 +00:00			* Run `yarn dl` to download the issues from the current month we're in and build the statistics and issue table, if you already have the issue files you can run `yarn nodl` to skip the downloading
			* To easily develop the website itself you can run `yarn watch` to watch the `src/` folder for changes and automatically lint the sass and build the files. Running `yarn watch` will open your default browser at `localhost:3000`.
			* To build the site only once you can do `yarn build`, the files will be built under `public/`, a requirement for GitLab Pages.
Add contributing and building sections to README 2018-06-24 22:56:52 +00:00
Massive change from Markdown to custom website with Pug & Sass 2018-07-16 01:29:01 +00:00			A new gitignored directory will be created like `data/2018/August` and have 2 folders and 2 [Pug](https://pugjs.org) files.
Add contributing and building sections to README 2018-06-24 22:56:52 +00:00
Massive change from Markdown to custom website with Pug & Sass 2018-07-16 01:29:01 +00:00			The folders are for issues both opened or closed during that month `table.pug` will be the issue table and `statistics.pug` will be the statistics.
Add contributing and building sections to README 2018-06-24 22:56:52 +00:00
Massive change from Markdown to custom website with Pug & Sass 2018-07-16 01:29:01 +00:00			If you're working on the generation process you can run `yarn nodl` to skip the downloading phase, this will only generate `table.pug` and `statistics.pug`. This way you don't have to wait several seconds for the GitLab API to respond.

			If you want to lint your sass (using [Stylelint](https://stylelint.io/)) manually you can run `yarn lint:sass`, in the future when we have JavaScript (if ever) there will also be a `yarn lint:js` task and a general task `yarn lint` however as there's 0 JS at the moment there's no need for JS linting.