Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

https://github.com/cds-snc/rcmp-report-a-cybercrime-alpha-documentation

beta cybercrime rcmp

Last synced: about 1 month ago
JSON representation

Alpha Phase Documentation

Host: GitHub
URL: https://github.com/cds-snc/rcmp-report-a-cybercrime-alpha-documentation
Owner: cds-snc
License: other
Created: 2019-09-24T12:32:32.000Z (about 5 years ago)
Default Branch: master
Last Pushed: 2024-01-21T14:07:05.000Z (11 months ago)
Last Synced: 2024-01-22T02:18:39.145Z (11 months ago)
Topics: beta, cybercrime, rcmp
Language: HTML
Homepage: https://rcmp-report-a-cybercrime-alpha-documentation.netlify.app/home/
Size: 6.78 MB
Stars: 1
Watchers: 12
Forks: 1
Open Issues: 18
Metadata Files:
- Readme: README.md
- Contributing: CONTRIBUTING.md
- License: COPYING.txt
- Code of conduct: CODE_OF_CONDUCT.md
- Security: SECURITY.md

# RCMP NC3 Report a Cybercrime Alpha Documentation

Documenting CDS and RCMP's work to help Canadians report a cybercrime or fraud

https://cds-snc.github.io/rcmp-report-a-cybercrime-alpha-documentation/home/

## Setting up your Macbook to have Ruby (very first time only)

Install Ruby
```
brew install ruby
```

Copy the line into your ~/.zshrc or ~/.bashrc

```
export PATH=/usr/local/opt/ruby/bin:$PATH
```

Restart your terminal (e.g. Quit and relaunch iTerm)
```
bundle update --bundler
```

## Editing the documentation

The documentation uses [Jekyll](http://jekyllrb.com/) and the [DOCter](https://github.com/cfpb/DOCter) theme.

DOCter needs Jekyll and other dependencies to run locally. These can be installed with Bundler by running the following commands.

```
gem install bundler
bundle install
```

Run Jekyll:

```
bundle exec jekyll serve --watch --baseurl ''
```

Open it up in your browser:

### _config.yml

Options within the `_config.yml` file allow you to control some of the site's
content and left column navigation.