Commit b1c03806 authored by Hyacinth Turbine's avatar Hyacinth Turbine

Merge branch 'master' into 'drafts'

# Conflicts:
#   pages/mydoc/221-Initial_Reply_For_Non-Spanish_Speakers.md
parents 6035834c 7950ab81
......@@ -2,4 +2,6 @@ _site/
.sass-cache/
.jekyll-metadata
_pdf
.idea/
\ No newline at end of file
.idea/
vendor/
.bundle/
image: ruby:2.3
image: ruby:2.6
cache:
paths:
- .apt
- vendor
pages:
before_script:
- export LC_ALL="C.UTF-8"
- export LANG="en_US.UTF-8"
- export LANGUAGE="en_US.UTF-8"
# Configure apt chaching
- echo $CI_PROJECT_DIR
- export APT_DIR=$CI_PROJECT_DIR/.apt && export APT_STATE_LISTS=$APT_DIR/lists && export APT_CACHE_ARCHIVES=$APT_DIR/archives
- printf "dir::state::lists ${APT_STATE_LISTS};\ndir::cache::archives ${APT_CACHE_ARCHIVES};\n" > /etc/apt/apt.conf
- mkdir -p "${APT_STATE_LISTS}/partial" && mkdir -p "${APT_CACHE_ARCHIVES}/partial"
- apt-get update -y && apt-get install -yq rsync
- eval $(ssh-agent -s)
# [old, removed] key is encoded via base64, hence we have to decode it
# [old, removed] - ssh-add <(echo "$SSH_PRIVATE_KEY" | base64 -d)
- ssh-add <(echo "$SSH_PRIVATE_KEY")
- mkdir -p ~/.ssh
- chmod 700 ~/.ssh
# next command is suggested here: https://stackoverflow.com/questions/25689231/getting-gitlab-ci-to-clone-private-repositories
- echo -e "Host *\n\tStrictHostKeyChecking no\n\n" > ~/.ssh/config
stage: deploy
script:
- gem install bundler
- bundle config set path 'vendor'
- bundle install
- bundle exec jekyll build -d public
#- scp -r public/* [email protected]:./communitydocs/
- rsync -av --delete public/ [email protected]:./communitydocs
artifacts:
paths:
- public
only:
- master
job2:
before_script:
- eval $(ssh-agent -s)
- ssh-add <(echo "$SSH_KEY")
- mkdir -p ~/.ssh
- chmod 700 ~/.ssh
- echo -e "Host *\n\tStrictHostKeyChecking no\n\n" > ~/.ssh/config
stage: deploy
script:
- git clone [email protected]:AccessNowHelpline/shared-documentation.git
- cd shared-documentation
- git config --local user.email "[email protected]"
- git config --local user.name "Access Now Helpline"
- git checkout drafts
- cp ../pages/mydoc/* pages/mydoc/
- git add pages/mydoc/*
- if [ $(git status --porcelain | wc -l) -ne 0 ]; then git commit -a -m "automatic push from confidential repository" && git push; fi
only:
- master
# job2:
# before_script:
# - eval $(ssh-agent -s)
# - ssh-add <(echo "$SSH_KEY")
# - mkdir -p ~/.ssh
# - chmod 700 ~/.ssh
# - echo -e "Host *\n\tStrictHostKeyChecking no\n\n" > ~/.ssh/config
# stage: deploy
# script:
# - git clone [email protected]:AccessNowHelpline/shared-documentation.git
# - cd shared-documentation
# - git config --local user.email "[email protected]"
# - git config --local user.name "Access Now Helpline"
# - git checkout drafts
# - cp ../pages/mydoc/* pages/mydoc/
# - git add pages/mydoc/*
# - if [ $(git status --porcelain | wc -l) -ne 0 ]; then git commit -a -m "automatic push from confidential repository" && git push; fi
# only:
# - master
// Place your settings in this file to overwrite default and user settings.
{
"files.associations": {
"*.html": "liquid"
}
}
......@@ -11,5 +11,4 @@ VOLUME /src
EXPOSE 4000
WORKDIR /src
ENTRYPOINT ["jekyll", "serve", "-H", "0.0.0.0"]
ENTRYPOINT ["jekyll", "serve", "--livereload", "-H", "0.0.0.0"]
source "https://rubygems.org"
gem 'github-pages', group: :jekyll_plugins
# gem 'github-pages', group: :jekyll_plugins
gem 'jekyll'
GEM
remote: https://rubygems.org/
specs:
activesupport (4.2.9)
i18n (~> 0.7)
minitest (~> 5.1)
thread_safe (~> 0.3, >= 0.3.4)
tzinfo (~> 1.1)
addressable (2.5.2)
addressable (2.6.0)
public_suffix (>= 2.0.2, < 4.0)
coffee-script (2.4.1)
coffee-script-source
execjs
coffee-script-source (1.11.1)
colorator (1.1.0)
commonmarker (0.17.9)
ruby-enum (~> 0.5)
concurrent-ruby (1.0.5)
concurrent-ruby (1.1.5)
em-websocket (0.5.1)
eventmachine (>= 0.12.9)
http_parser.rb (~> 0.6.0)
ethon (0.11.0)
ffi (>= 1.3.0)
eventmachine (1.2.5)
execjs (2.7.0)
faraday (0.15.0)
multipart-post (>= 1.2, < 3)
ffi (1.9.23)
eventmachine (1.2.7)
ffi (1.11.1)
forwardable-extended (2.6.0)
gemoji (3.0.0)
github-pages (182)
activesupport (= 4.2.9)
github-pages-health-check (= 1.4.0)
jekyll (= 3.7.3)
jekyll-avatar (= 0.5.0)
jekyll-coffeescript (= 1.1.1)
jekyll-commonmark-ghpages (= 0.1.5)
jekyll-default-layout (= 0.1.4)
jekyll-feed (= 0.9.3)
jekyll-gist (= 1.5.0)
jekyll-github-metadata (= 2.9.4)
jekyll-mentions (= 1.3.0)
jekyll-optional-front-matter (= 0.3.0)
jekyll-paginate (= 1.1.0)
jekyll-readme-index (= 0.2.0)
jekyll-redirect-from (= 0.13.0)
jekyll-relative-links (= 0.5.3)
jekyll-remote-theme (= 0.2.3)
jekyll-sass-converter (= 1.5.2)
jekyll-seo-tag (= 2.4.0)
jekyll-sitemap (= 1.2.0)
jekyll-swiss (= 0.4.0)
jekyll-theme-architect (= 0.1.1)
jekyll-theme-cayman (= 0.1.1)
jekyll-theme-dinky (= 0.1.1)
jekyll-theme-hacker (= 0.1.1)
jekyll-theme-leap-day (= 0.1.1)
jekyll-theme-merlot (= 0.1.1)
jekyll-theme-midnight (= 0.1.1)
jekyll-theme-minimal (= 0.1.1)
jekyll-theme-modernist (= 0.1.1)
jekyll-theme-primer (= 0.5.3)
jekyll-theme-slate (= 0.1.1)
jekyll-theme-tactile (= 0.1.1)
jekyll-theme-time-machine (= 0.1.1)
jekyll-titles-from-headings (= 0.5.1)
jemoji (= 0.9.0)
kramdown (= 1.16.2)
liquid (= 4.0.0)
listen (= 3.1.5)
mercenary (~> 0.3)
minima (= 2.4.1)
nokogiri (>= 1.8.1, < 2.0)
rouge (= 2.2.1)
terminal-table (~> 1.4)
github-pages-health-check (1.4.0)
addressable (~> 2.3)
net-dns (~> 0.8)
octokit (~> 4.0)
public_suffix (~> 2.0)
typhoeus (~> 1.3)
html-pipeline (2.7.2)
activesupport (>= 2)
nokogiri (>= 1.4)
http_parser.rb (0.6.0)
i18n (0.9.5)
concurrent-ruby (~> 1.0)
jekyll (3.7.3)
jekyll (3.8.5)
addressable (~> 2.4)
colorator (~> 1.0)
em-websocket (~> 0.5)
......@@ -98,153 +27,37 @@ GEM
pathutil (~> 0.9)
rouge (>= 1.7, < 4)
safe_yaml (~> 1.0)
jekyll-avatar (0.5.0)
jekyll (~> 3.0)
jekyll-coffeescript (1.1.1)
coffee-script (~> 2.2)
coffee-script-source (~> 1.11.1)
jekyll-commonmark (1.2.0)
commonmarker (~> 0.14)
jekyll (>= 3.0, < 4.0)
jekyll-commonmark-ghpages (0.1.5)
commonmarker (~> 0.17.6)
jekyll-commonmark (~> 1)
rouge (~> 2)
jekyll-default-layout (0.1.4)
jekyll (~> 3.0)
jekyll-feed (0.9.3)
jekyll (~> 3.3)
jekyll-gist (1.5.0)
octokit (~> 4.2)
jekyll-github-metadata (2.9.4)
jekyll (~> 3.1)
octokit (~> 4.0, != 4.4.0)
jekyll-mentions (1.3.0)
activesupport (~> 4.0)
html-pipeline (~> 2.3)
jekyll (~> 3.0)
jekyll-optional-front-matter (0.3.0)
jekyll (~> 3.0)
jekyll-paginate (1.1.0)
jekyll-readme-index (0.2.0)
jekyll (~> 3.0)
jekyll-redirect-from (0.13.0)
jekyll (~> 3.3)
jekyll-relative-links (0.5.3)
jekyll (~> 3.3)
jekyll-remote-theme (0.2.3)
jekyll (~> 3.5)
rubyzip (>= 1.2.1, < 3.0)
typhoeus (>= 0.7, < 2.0)
jekyll-sass-converter (1.5.2)
sass (~> 3.4)
jekyll-seo-tag (2.4.0)
jekyll (~> 3.3)
jekyll-sitemap (1.2.0)
jekyll (~> 3.3)
jekyll-swiss (0.4.0)
jekyll-theme-architect (0.1.1)
jekyll (~> 3.5)
jekyll-seo-tag (~> 2.0)
jekyll-theme-cayman (0.1.1)
jekyll (~> 3.5)
jekyll-seo-tag (~> 2.0)
jekyll-theme-dinky (0.1.1)
jekyll (~> 3.5)
jekyll-seo-tag (~> 2.0)
jekyll-theme-hacker (0.1.1)
jekyll (~> 3.5)
jekyll-seo-tag (~> 2.0)
jekyll-theme-leap-day (0.1.1)
jekyll (~> 3.5)
jekyll-seo-tag (~> 2.0)
jekyll-theme-merlot (0.1.1)
jekyll (~> 3.5)
jekyll-seo-tag (~> 2.0)
jekyll-theme-midnight (0.1.1)
jekyll (~> 3.5)
jekyll-seo-tag (~> 2.0)
jekyll-theme-minimal (0.1.1)
jekyll (~> 3.5)
jekyll-seo-tag (~> 2.0)
jekyll-theme-modernist (0.1.1)
jekyll (~> 3.5)
jekyll-seo-tag (~> 2.0)
jekyll-theme-primer (0.5.3)
jekyll (~> 3.5)
jekyll-github-metadata (~> 2.9)
jekyll-seo-tag (~> 2.0)
jekyll-theme-slate (0.1.1)
jekyll (~> 3.5)
jekyll-seo-tag (~> 2.0)
jekyll-theme-tactile (0.1.1)
jekyll (~> 3.5)
jekyll-seo-tag (~> 2.0)
jekyll-theme-time-machine (0.1.1)
jekyll (~> 3.5)
jekyll-seo-tag (~> 2.0)
jekyll-titles-from-headings (0.5.1)
jekyll (~> 3.3)
jekyll-watch (2.0.0)
jekyll-watch (2.2.1)
listen (~> 3.0)
jemoji (0.9.0)
activesupport (~> 4.0, >= 4.2.9)
gemoji (~> 3.0)
html-pipeline (~> 2.2)
jekyll (~> 3.0)
kramdown (1.16.2)
kramdown (1.17.0)
liquid (4.0.0)
listen (3.1.5)
rb-fsevent (~> 0.9, >= 0.9.4)
rb-inotify (~> 0.9, >= 0.9.7)
ruby_dep (~> 1.2)
mercenary (0.3.6)
mini_portile2 (2.3.0)
minima (2.4.1)
jekyll (~> 3.5)
jekyll-feed (~> 0.9)
jekyll-seo-tag (~> 2.1)
minitest (5.11.3)
multipart-post (2.0.0)
net-dns (0.8.0)
nokogiri (1.8.2)
mini_portile2 (~> 2.3.0)
octokit (4.8.0)
sawyer (~> 0.8.0, >= 0.5.3)
pathutil (0.16.1)
pathutil (0.16.2)
forwardable-extended (~> 2.6)
public_suffix (2.0.5)
public_suffix (3.0.3)
rb-fsevent (0.10.3)
rb-inotify (0.9.10)
ffi (>= 0.5.0, < 2)
rb-inotify (0.10.0)
ffi (~> 1.0)
rouge (2.2.1)
ruby-enum (0.7.2)
i18n
ruby_dep (1.5.0)
rubyzip (1.2.1)
safe_yaml (1.0.4)
sass (3.5.6)
safe_yaml (1.0.5)
sass (3.7.4)
sass-listen (~> 4.0.0)
sass-listen (4.0.0)
rb-fsevent (~> 0.9, >= 0.9.4)
rb-inotify (~> 0.9, >= 0.9.7)
sawyer (0.8.1)
addressable (>= 2.3.5, < 2.6)
faraday (~> 0.8, < 1.0)
terminal-table (1.8.0)
unicode-display_width (~> 1.1, >= 1.1.1)
thread_safe (0.3.6)
typhoeus (1.3.0)
ethon (>= 0.9.0)
tzinfo (1.2.5)
thread_safe (~> 0.1)
unicode-display_width (1.3.2)
PLATFORMS
ruby
DEPENDENCIES
github-pages
jekyll
BUNDLED WITH
1.16.1
2.0.2
......@@ -11,6 +11,8 @@ Repository for Access Now Digital Security Helpline's public documentation.
If you are planning to edit a page of Access Now Helpline's [Community Documentation website](https://accessnowhelpline.gitlab.io/community-documentation/), you can identify the file that needs to be edited in this repository by clicking the "Edit me" button in the relevant web page.
If you want to translate a document, please see [these instructions](pages/mydoc/translation_readme.md)
### Suggesting an Edit
If you would like to suggest or discuss an edit, you can submit an [issue in this project](https://gitlab.com/AccessNowHelpline/community-documentation/issues).
......@@ -172,6 +174,38 @@ What follows is a step-by-step guide to download a synchronized clone of your fo
Thank you for contributing to Access Now Digital Security Helpline Community documentation!
### Creating New Articles or Templates
#### 0. Before Writing
A couple of steps are required before you even start writing:
- Make sure that you have a clear idea of the technical solutions required to solve the case type described in the article, and discuss them with your team and, if necessary, with your community. Also make sure that this documentation doesn't already exist.
- Make sure that the case can be generalized to a broader type of issues.
#### 1. Drafting an Article for RT
Draft the article in markdown in a new branch.
- When writing an article, use this [template](https://gitlab.com/AccessNowHelpline/community-documentation/blob/master/pages/mydoc/article_template.md).
- When writing a message template use this [template](https://gitlab.com/AccessNowHelpline/community-documentation/blob/master/pages/mydoc/email_template.md).
*Both these templates include a series of meta tags in the front
matter included between 3 hyphens at the top of the document. These meta tags
won't be visible in the final web page, but are important for the final website
deployment and for its layout, as well as for the continuous integration scripts.
They should be filled out as carefully as every other field in the templates. See ["YAML front matter"](#yaml) below for a description of each tag in the front matter.*
#### 2. Publication on communitydocs.accessnow.org
1. Open a merge request (click [here](https://gitlab.com/AccessNowHelpline/community-documentation/-/merge_requests/new)) from the "draft" branch to the "master" branch of this repository. The administrators of this repository will be notified about your proposed changes.
2. When the content has been reviewed, the administrators of this repository will merge your changes to the master branch, publishing the change on the communitydocs website.
### Types of content
The content in this website is organized hierarchically, as outlined in the following list:
......@@ -186,6 +220,7 @@ If you plan to add a new FAQ or article to the repository, you can start by dupl
If you are adding an email template, you can base it on [this file](https://gitlab.com/AccessNowHelpline/community-documentation/blob/master/pages/mydoc/email_template.md).
<a name="yaml"></a>
### YAML front matter
......@@ -211,6 +246,8 @@ The YAML front matter (the keys and values included between `---` at the beginni
- conf: Public - **leave this unchanged**.
- ref: a unique identifier for each localized version of the same article. If you are creating a new article, this can be any identifier matching with the title, without spaces. If you are translating an existing article, the identifier needs to be identical to the one in the original version that you are translating.
- lang: add 2-letters code for the language used in the article.
......@@ -234,6 +271,8 @@ The YAML front matter (the keys and values included between `---` at the beginni
- conf: Public - **leave this unchanged**.
- ref: a unique identifier for each localized version of the same article. If you are creating a new article, this can be any identifier matching with the title, without spaces. If you are translating an existing article, the identifier needs to be identical to the one in the original version that you are translating.
- lang: add 2-letters code for the language used in the article.
......
......@@ -5,7 +5,17 @@ encoding: utf-8
output: web
# this property is useful for conditional filtering of content that is separate from the PDF.
topnav_title: Access Now Digital Security Helpline Public Documentation
topnav_title: multilanguage
m_topnav_title:
en: Access Now Digital Security Helpline Public Documentation
it: Documentazione pubblica della Helpline di sicurezza informatica di Access Now
ru: Документация сообщества Службы поддержки по цифровой безопасности Access Now
es: Documentación comunitaria de la línea de ayuda en seguridad digital de Access Now
fr: Documentation de communauté de la plateforme d’assistance numérique d'Access Now
pt: Documentação da comunidade da Linha de Ajuda em Segurança Digital do Access Now
de: Dokumentation für die Gemeinschaft der Digital Security Helpline
fl: Dokumentasyon para sa Komunidad nang Access Now Digital Security Helpline
ar: وثائق مجتمع فريق مساعدو الأمن الرقمي باكساس ناو
# this appears on the top navigation bar next to the home button
site_title: Access Now Digital Security Helpline Public Documentation
......@@ -36,6 +46,14 @@ port: 4000
exclude:
- .idea/
- .gitignore
- vendor/*
- bin/
- docker-compose.yml
- Dockerfile
- Gemfile
- Gemfile.lock
- README.md
- var/
# these are the files and directories that jekyll will exclude from the build
feedback_subject_line: Access Now Digital Security Helpline Community Documentation
......@@ -78,7 +96,7 @@ defaults:
layout: "page"
comments: true
search: true
sidebar: home_sidebar
sidebar: mydoc_sidebar
topnav: topnav
-
scope:
......@@ -104,15 +122,12 @@ defaults:
# these are defaults used for the frontmatter for these file types
sidebars:
- home_sidebar
- mydoc_sidebar
- product1_sidebar
- product2_sidebar
- other
- home_sidebar
description: "Community Documentation for Access Now's Digital Security Helpline"
# the description is used in the feed.xml file
# needed for sitemap.xml file only
url: https://accessnowhelpline.gitlab.io
url: https://communitydocs.accessnow.org
baseurl: /community-documentation
......@@ -7,7 +7,7 @@ entries:
- title: Bananas
url: bananas.html
subfolder:
subfolders:
- title: Apples
subfolderitems:
......@@ -59,14 +59,14 @@ about:
- zero
- one
- two
- three
- three
numbercolors:
- zero:
properties: red
- one:
properties: yellow
- two:
- two:
properties: green
- three:
properties: blue
......@@ -93,15 +93,15 @@ mypages:
product: acme
url: microsoft.com
feedback: >
feedback: >
This is my feedback to you.
Even if I include linebreaks here,
all of the linebreaks will be removed when the value is inserted.
block: |
This pipe does something a little different.
This pipe does something a little different.
It preserves the breaks.
This is really helpful for code samples,
This is really helpful for code samples,
since you can format the code samples with
the appropriate
white spacing.
\ No newline at end of file
white spacing.
......@@ -2,8 +2,10 @@
entries:
- title: sidebar
product: Helpline Community Documentation
version: 1.0
product: multilanguage
en:
it:
# version: 1.0
folders:
- title:
......@@ -19,7 +21,16 @@ entries:
output: pdf
type: frontmatter
- title: Articles
- title: multilanguage
en: Articles
it: Articoli
ru: Статьи
fr: Articles
de: Artikel
fl: Artikulo
ar: مقالات
es: Artículos
pt: Artigos
output: web, pdf
folderitems:
......@@ -37,71 +48,89 @@ entries:
url: /tag_account_security.html
output: web, pdf
type: homepage
lang: en
- title: Anonymity and Circumvention
url: /tag_anonymity_circumvention.html
output: web, pdf
lang: en
- title: Browsing Security
url: /tag_browsing_security.html
output: web, pdf
type: homepage
lang: en
- title: Censorship
url: /tag_censorship.html
output: web, pdf
lang: en
- title: Data Leaks
url: /tag_data_leaks.html
output: web, pdf
lang: en
- title: DDoS Attack
url: /tag_ddos_attack.html
output: web, pdf
lang: en
- title: Defacement
url: /tag_defacement.html
output: web, pdf
lang: en
- title: Devices and Data Security
url: /tag_devices_data_security.html
output: web, pdf
lang: en
- title: Direct Intervention
url: /tag_direct_intervention.html
output: web, pdf
lang: en
# - title: Direct Intervention
# url: /tag_direct_intervention.html
# output: web, pdf
#
- title: Documentation
url: /tag_documentation.html
output: web, pdf
lang: en
- title: Fake Domain Mitigation
url: /tag_fake_domain.html
output: web, pdf
# - title: Fake Domain Mitigation