Skip to content

Commit

Permalink
Add base help site looking like current one
Browse files Browse the repository at this point in the history
  • Loading branch information
stripthis committed Jan 20, 2018
1 parent edd7723 commit 2fb2494
Show file tree
Hide file tree
Showing 143 changed files with 4,401 additions and 147 deletions.
24 changes: 0 additions & 24 deletions 404.html

This file was deleted.

4 changes: 4 additions & 0 deletions 404.md
@@ -0,0 +1,4 @@
---
# Do not edit this file, see _layout/404.html
layout: 404
---
94 changes: 94 additions & 0 deletions Gruntfile.js
@@ -0,0 +1,94 @@
/**
* Gruntfile
* Provides tasks and commands to build and distribute the project
*
* @param grunt
* @copyright (c) 2017 Passbolt SARL
* @licence GNU Affero General Public License http://www.gnu.org/licenses/agpl-3.0.en.html
*/
module.exports = function(grunt) {

/**
* Path shortcuts
*/
var path = {
node_modules: 'node_modules/',
assets: 'assets/',
css: 'assets/css/',
images: 'assets/img/',
fonts: 'assets/fonts/'
};

/**
* Import package.json file content
*/
var pkg = grunt.file.readJSON('package.json');

/**
* Load and enable Tasks
*/
grunt.loadNpmTasks('grunt-contrib-copy');
grunt.registerTask('default', ['styleguide-update']);
grunt.registerTask('styleguide-update', ['copy:styleguide']);

/**
* Main grunt tasks configuration
*/
grunt.initConfig({
pkg: grunt.file.readJSON('package.json'),

/**
* Copy operations
*/
copy: {
// Copy styleguide elements
styleguide: {
files: [{
// Icons
nonull: true,
cwd: path.node_modules + 'passbolt-styleguide/src/img/logo',
src: ['logo.png', 'logo@2x.png'],
dest: path.images + 'logo',
expand: true
}, {
// CSS files
cwd: path.node_modules + 'passbolt-styleguide/build/css',
src: ['help.min.css'],
dest: path.css,
expand: true
}, {
// Font files
cwd: path.node_modules + 'passbolt-styleguide/src/fonts',
src: '*',
dest: path.fonts,
expand: true
}, {
// Icon
cwd: path.node_modules + 'passbolt-styleguide/src/img/webroot',
src: 'favicon.ico',
dest: path.assets,
expand: true
}, {
// 3rd party logos
cwd: path.node_modules + 'passbolt-styleguide/src/img/third_party',
src: ['docker_small_h.png'],
dest: path.images + 'third_party',
expand: true
}, {
// 3rd party logos
cwd: path.node_modules + 'passbolt-styleguide/src/img/screenshots',
src: '*',
dest: path.images + 'screenshots',
expand: true
}, {
// Illustrations
cwd: path.node_modules + 'passbolt-styleguide/src/img/illustrations',
src: ['birds6_850.png'],
dest: path.images + 'illustrations',
expand: true
}]
}
}

});
};
43 changes: 26 additions & 17 deletions _config.yml
Expand Up @@ -13,14 +13,16 @@
# you will see them accessed via {{ site.title }}, {{ site.email }}, and so on.
# You can create any custom variable you would like, and they will be accessible
# in the templates via {{ site.myvariable }}.
title: Your awesome title
email: your-email@example.com
title: Passbolt | Help
email: contact@passbolt.com
description: >- # this means to ignore newlines until "baseurl:"
Write an awesome description for your new site here. You can edit this
line in _config.yml. It will appear in your document head meta (for
Google search results) and in your feed.xml site description.
baseurl: "" # the subpath of your site, e.g. /blog
url: "" # the base hostname & protocol for your site, e.g. http://example.com
The help site for passbolt, the open source password manager for teams.
This site contains frequently asked questions, article to troubleshoot common issues,
installation tutorials, blueprints for developers, and more!
baseurl: ""
url: "//help.passbolt.com"

twitter_username: passbolt
github_username: passbolt

Expand All @@ -29,14 +31,21 @@ markdown: kramdown
plugins:
- jekyll-feed

# Additional folders and collections
include: ['_pages']
collections:
faq:
category: nil
output: true
default:
layout: default

# Exclude from processing.
# The following items will not be processed, by default. Create a custom list
# to override the default setting.
# exclude:
# - Gemfile
# - Gemfile.lock
# - node_modules
# - vendor/bundle/
# - vendor/cache/
# - vendor/gems/
# - vendor/ruby/
exclude:
- package.json
- package-lock.json
- Gruntfile.js
- node_modules
- Gemfile
- Gemfile.lock

14 changes: 14 additions & 0 deletions _data/members.yml
@@ -0,0 +1,14 @@
- name: Cedric Alfonsi
github: cedricalfonsi

- name: Diego Lendoiro
github: dlen

- name: Kevin Muller
github: kevinmuller

- name: Remy Bertot
github: stripthis

- name: Laura Hilliger
github: laurahilliger
10 changes: 10 additions & 0 deletions _data/sidebars.yml
@@ -0,0 +1,10 @@
sidebar:
- title: Hosting
slug: hosting
subfolderitems:
- page: Installation
slug: install
- page: Update
slug: update
- page: Backup
slug: backup
85 changes: 85 additions & 0 deletions _data/toc.yml
@@ -0,0 +1,85 @@
- title: Getting started
slug: start
teaser: Everbody have to start somewhere
items:
- title: FAQ
url: /faq/start
icon: fa-compass
teaser: Everybody have to start somewhere.
- title: Forum
url: https://community.passbolt.com
icon: fa-comments
teaser: When in doubt, ask the community!
- title: Feature requests
slug: https://community.passbolt.com/c/backlog
icon: fa-plus-circle
teaser: Propose and vote for new ideas!
- title: Bug report
url: https://github.com/passbolt/passbolt_api/issues/new
icon: fa-bug
teaser: Who knows, maybe it is a feature?
- title: Release notes!
url: https://www.passbolt.com/release/notes
icon: fa-tags
teaser: Find out what have changed since last time!
- title: Incident reports
url: https://www.passbolt.com/incidents
icon: fa-fire-extinguisher
teaser: What went wrong and what we did to fix it.
- title: Hosting
slug: hosting
teaser: Hosting a passbolt server
items:
- title: Installation
slug: install
icon: fa-cogs
teaser: How to install passbolt on your own server
- title: Update
slug: update
icon: fa-refresh
teaser: How to update a self-hosted passsbolt instance
- title: Backup
slug: backup
icon: fa-download
teaser: Guidelines to backup a passbolt instance
- title: Installation issues
url: https://community.passbolt.com/c/installation-issues
icon: fa-life-saver
teaser: Do you need help to install passbolt?
- title: Authentication
url: https://www.passbolt.com/help/tech/auth
icon: fa-lock
teaser: How does GPG Authentication work?
- title: Github
url: https://www.github.com/passbolt
icon: fa-github
teaser: Want to see the code? This way!
- title: Legal Topics
slug: legal
url: https://www.passbolt.com/terms
teaser: The small prints
items:
- title: Terms of service
url: https://www.passbolt.com/terms
icon: fa-balance-scale
teaser: Did you read the small prints?
- title: Privacy policy
url: https://www.passbolt.com/privacy
icon: fa-street-view
teaser: What we do with your data.
- title: CLA Policy
url: https://www.passbolt.com/legal/cla
icon: fa-pencil
teaser: Contributor licence agreement
- title: Code of conduct
url: https://www.passbolt.com/code_of_conduct
icon: fa-users
teaser: Because everyone should feel welcome
- title: Talk to a human
url: https://community.passbolt.com/c/site-feedback
icon: fa-comment
teaser: We are not machines and it's a cold world out there.
- title: Credits
url: https://www.passbolt.com/credits
teaser: Passbolt would not be possible without...
icon: fa-hand-peace-o
7 changes: 7 additions & 0 deletions _faq/contributing/000-how-can-i-contribute-code.md
@@ -0,0 +1,7 @@
---
title:
slug:
layout:
category: support
permalink: /faq/start/:slug
---
7 changes: 7 additions & 0 deletions _faq/contributing/000-how-can-i-contribute-design-ideas.md
@@ -0,0 +1,7 @@
---
title:
slug:
layout:
category: support
permalink: /faq/start/:slug
---
7 changes: 7 additions & 0 deletions _faq/contributing/000-how-can-i-contribute-financially.md
@@ -0,0 +1,7 @@
---
title:
slug:
layout:
category: support
permalink: /faq/start/:slug
---
7 changes: 7 additions & 0 deletions _faq/contributing/000-how-can-i-support-passbolt.md
@@ -0,0 +1,7 @@
---
title:
slug:
layout:
category: support
permalink: /faq/start/:slug
---
7 changes: 7 additions & 0 deletions _faq/contributing/000-how-to-report-bugs.md
@@ -0,0 +1,7 @@
---
title:
slug:
layout:
category: support
permalink: /faq/start/:slug
---
7 changes: 7 additions & 0 deletions _faq/hosting/000-how-to-install.md
@@ -0,0 +1,7 @@
---
title:
slug:
layout:
category: hosting
permalink: /faq/start/:slug
---
7 changes: 7 additions & 0 deletions _faq/hosting/000-how-to-make-backup.md
@@ -0,0 +1,7 @@
---
title:
slug:
layout:
category: hosting
permalink: /faq/start/:slug
---
7 changes: 7 additions & 0 deletions _faq/hosting/000-how-to-update.md
@@ -0,0 +1,7 @@
---
title:
slug:
layout:
category: hosting
permalink: /faq/start/:slug
---
7 changes: 7 additions & 0 deletions _faq/hosting/001-do-you-provide-hosting.md
@@ -0,0 +1,7 @@
---
title:
slug:
layout:
category: hosting
permalink: /faq/start/:slug
---
7 changes: 7 additions & 0 deletions _faq/hosting/001-where-to-get-help-for-installation.md
@@ -0,0 +1,7 @@
---
title:
slug:
layout:
category: hosting
permalink: /faq/start/:slug
---
9 changes: 9 additions & 0 deletions _faq/index.html
@@ -0,0 +1,9 @@
---
title: Getting started faq
layout: default
category: start
notsearchable: true
slug: faq
sidebar: asside/community.html
---
{% include faq/start.html %}
8 changes: 8 additions & 0 deletions _faq/licensing/000-which-license.md
@@ -0,0 +1,8 @@
---
title:
slug:
layout:
category: licensing
permalink: /faq/start/:slug
---

0 comments on commit 2fb2494

Please sign in to comment.