Skip to content

Commit 24f1a04

Browse files
gionngionn
authored
OPSEXP-2603 Adopt jekyll for docs website (#821)
1 parent 626e6b7 commit 24f1a04

23 files changed

+277
-16
lines changed

‎.github/workflows/docs.yml

+63
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,63 @@
1+
name: Deploy docs
2+
3+
on:
4+
push:
5+
branches: ["master"]
6+
paths:
7+
- "docs/**"
8+
pull_request:
9+
branches: ["master"]
10+
paths:
11+
- "docs/**"
12+
13+
# Sets permissions of the GITHUB_TOKEN to allow deployment to GitHub Pages
14+
permissions:
15+
contents: read
16+
pages: write
17+
id-token: write
18+
19+
jobs:
20+
build:
21+
runs-on: ubuntu-latest
22+
defaults:
23+
run:
24+
working-directory: docs
25+
steps:
26+
- name: Checkout
27+
uses: actions/checkout@f43a0e5ff2bd294095638e18286ca9a3d1956744 # v3.6.0
28+
29+
- name: Setup Ruby
30+
uses: ruby/setup-ruby@5f19ec79cedfadb78ab837f95b87734d0003c899 # v1.173.0
31+
with:
32+
working-directory: '${{ github.workspace }}/docs'
33+
bundler-cache: true
34+
35+
- name: Setup Pages
36+
id: pages
37+
uses: actions/configure-pages@b8130d9ab958b325bbde9786d62f2c97a9885a0e # v3.0.7
38+
39+
- name: Build with Jekyll
40+
run: bundle exec jekyll build --baseurl "${{ steps.pages.outputs.base_path }}"
41+
env:
42+
JEKYLL_ENV: production
43+
44+
- name: Upload artifact
45+
if: github.event_name == 'push' && github.ref_name == 'master'
46+
uses: actions/upload-pages-artifact@84bb4cd4b733d5c320c9c9cfbc354937524f4d64 # v1.0.10
47+
with:
48+
path: "docs/_site/"
49+
50+
deploy:
51+
runs-on: ubuntu-latest
52+
if: github.event_name == 'push' && github.ref_name == 'master'
53+
concurrency:
54+
group: "pages"
55+
cancel-in-progress: true
56+
environment:
57+
name: github-pages
58+
url: ${{ steps.deployment.outputs.page_url }}
59+
needs: build
60+
steps:
61+
- name: Deploy to GitHub Pages
62+
id: deployment
63+
uses: actions/deploy-pages@de14547edc9944350dc0481aa5b7afb08e75f254 # v2.0.5

‎.pre-commit-config.yaml

+1-1
Original file line numberDiff line numberDiff line change
@@ -22,7 +22,7 @@ repos:
2222
- id: djlint-jinja
2323

2424
- repo: https://github.com/jackdewinter/pymarkdown
25-
rev: v0.9.15
25+
rev: v0.9.18
2626
hooks:
2727
- id: pymarkdown
2828
files: (README\.md$|docs/.*\.md)

‎.pymarkdown.json

+6-7
Original file line numberDiff line numberDiff line change
@@ -1,16 +1,15 @@
11
{
22
"plugins": {
3-
"no-space-in-code": {
4-
"enabled": false
5-
},
6-
"no-space-in-emphasis": {
7-
"enabled": false
8-
},
93
"line-length": {
104
"enabled": false
115
},
12-
"no-duplicate-heading": {
6+
"single-h1": {
137
"enabled": false
148
}
9+
},
10+
"extensions": {
11+
"front-matter": {
12+
"enabled": true
13+
}
1514
}
1615
}

‎docs/.gitignore

+15
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,15 @@
1+
# Not sure what a .gitignore is?
2+
# See: https://git-scm.com/docs/gitignore
3+
4+
# These are directly copied from Jekyll's first-party docs on `.gitignore` files:
5+
# https://jekyllrb.com/tutorials/using-jekyll-with-bundler/#commit-to-source-control
6+
7+
# Ignore the default location of the built site, and caches and metadata generated by Jekyll
8+
_site/
9+
.sass-cache/
10+
.jekyll-cache/
11+
.jekyll-metadata
12+
13+
# Ignore folders generated by Bundler
14+
.bundle/
15+
vendor/

‎docs/.ruby-version

+1
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
3.1.4

‎docs/CONTRIBUTING.md

+4
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,7 @@
1+
---
2+
title: Contributing
3+
---
4+
15
# Contributing
26

37
Thanks for your interest in contributing to this project!

‎docs/Gemfile

+7
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,7 @@
1+
source 'https://rubygems.org'
2+
3+
gem "jekyll", "~> 4.3.3" # installed by `gem jekyll`
4+
# gem "webrick" # required when using Ruby >= 3 and Jekyll <= 4.2.2
5+
6+
gem "just-the-docs", "0.8.1" # pinned to the current release
7+
# gem "just-the-docs" # always download the latest release

‎docs/Gemfile.lock

+89
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,89 @@
1+
GEM
2+
remote: https://rubygems.org/
3+
specs:
4+
addressable (2.8.6)
5+
public_suffix (>= 2.0.2, < 6.0)
6+
colorator (1.1.0)
7+
concurrent-ruby (1.2.2)
8+
em-websocket (0.5.3)
9+
eventmachine (>= 0.12.9)
10+
http_parser.rb (~> 0)
11+
eventmachine (1.2.7)
12+
ffi (1.16.3)
13+
forwardable-extended (2.6.0)
14+
google-protobuf (3.25.1-arm64-darwin)
15+
google-protobuf (3.25.1-x86_64-darwin)
16+
google-protobuf (3.25.1-x86_64-linux)
17+
http_parser.rb (0.8.0)
18+
i18n (1.14.1)
19+
concurrent-ruby (~> 1.0)
20+
jekyll (4.3.3)
21+
addressable (~> 2.4)
22+
colorator (~> 1.0)
23+
em-websocket (~> 0.5)
24+
i18n (~> 1.0)
25+
jekyll-sass-converter (>= 2.0, < 4.0)
26+
jekyll-watch (~> 2.0)
27+
kramdown (~> 2.3, >= 2.3.1)
28+
kramdown-parser-gfm (~> 1.0)
29+
liquid (~> 4.0)
30+
mercenary (>= 0.3.6, < 0.5)
31+
pathutil (~> 0.9)
32+
rouge (>= 3.0, < 5.0)
33+
safe_yaml (~> 1.0)
34+
terminal-table (>= 1.8, < 4.0)
35+
webrick (~> 1.7)
36+
jekyll-include-cache (0.2.1)
37+
jekyll (>= 3.7, < 5.0)
38+
jekyll-sass-converter (3.0.0)
39+
sass-embedded (~> 1.54)
40+
jekyll-seo-tag (2.8.0)
41+
jekyll (>= 3.8, < 5.0)
42+
jekyll-watch (2.2.1)
43+
listen (~> 3.0)
44+
just-the-docs (0.8.1)
45+
jekyll (>= 3.8.5)
46+
jekyll-include-cache
47+
jekyll-seo-tag (>= 2.0)
48+
rake (>= 12.3.1)
49+
kramdown (2.4.0)
50+
rexml
51+
kramdown-parser-gfm (1.1.0)
52+
kramdown (~> 2.0)
53+
liquid (4.0.4)
54+
listen (3.8.0)
55+
rb-fsevent (~> 0.10, >= 0.10.3)
56+
rb-inotify (~> 0.9, >= 0.9.10)
57+
mercenary (0.4.0)
58+
pathutil (0.16.2)
59+
forwardable-extended (~> 2.6)
60+
public_suffix (5.0.4)
61+
rake (13.1.0)
62+
rb-fsevent (0.11.2)
63+
rb-inotify (0.10.1)
64+
ffi (~> 1.0)
65+
rexml (3.2.6)
66+
rouge (4.2.0)
67+
safe_yaml (1.0.5)
68+
sass-embedded (1.69.5-arm64-darwin)
69+
google-protobuf (~> 3.23)
70+
sass-embedded (1.69.5-x86_64-darwin)
71+
google-protobuf (~> 3.23)
72+
sass-embedded (1.69.5-x86_64-linux-gnu)
73+
google-protobuf (~> 3.23)
74+
terminal-table (3.0.2)
75+
unicode-display_width (>= 1.1.1, < 3)
76+
unicode-display_width (2.5.0)
77+
webrick (1.8.1)
78+
79+
PLATFORMS
80+
arm64-darwin-23
81+
x86_64-darwin-23
82+
x86_64-linux
83+
84+
DEPENDENCIES
85+
jekyll (~> 4.3.3)
86+
just-the-docs (= 0.8.1)
87+
88+
BUNDLED WITH
89+
2.3.26

‎docs/SECRETS.md

+4
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,7 @@
1+
---
2+
title: Secrets
3+
---
4+
15
# Secrets
26

37
This page describe how secrets are securely managed in our playbook. It also

‎docs/SECURITY.md

+5-1
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,8 @@
1-
# SECURITY
1+
---
2+
title: Security
3+
---
4+
5+
# Security
26

37
This pages focuses on providing information on making the platform deployed
48
with alfresco-ansible-deployment secure.

‎docs/_config.yml

+28
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,28 @@
1+
title: Alfresco Ansible Deployment
2+
description: Deploy alfresco with Ansible
3+
theme: just-the-docs
4+
color_scheme: alfresco
5+
6+
url: https://gionn.github.io/alfresco-ansible-deployment
7+
8+
aux_links:
9+
Docs: https://docs.alfresco.com/
10+
GitHub Repository: https://github.com/Alfresco/alfresco-ansible-deployment
11+
12+
aux_links_new_tab: true
13+
14+
gh_edit_link: true
15+
gh_edit_link_text: "Improve this page on GitHub"
16+
gh_edit_repository: https://github.com/Alfresco/alfresco-ansible-deployment
17+
gh_edit_branch: master
18+
gh_edit_source: docs
19+
gh_edit_view_mode: edit
20+
21+
logo: "resources/hyland-alfresco-logos.png"
22+
favicon_ico: "favicon.ico"
23+
24+
defaults:
25+
- scope:
26+
path: "" # an empty string here means all files in the project
27+
values:
28+
layout: "default"

‎docs/_includes/head_custom.html

+3
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,3 @@
1+
<style>
2+
@import url('https://fonts.googleapis.com/css2?family=Inter:[email protected]&display=swap')
3+
</style>

‎docs/_sass/color_schemes/alfresco.scss

+9
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,9 @@
1+
$link-color: #3273dc;
2+
$body-font-family: "Inter", sans-serif;
3+
4+
$font-size-5: 0.88rem;
5+
6+
.main-content {
7+
color: #212328;
8+
font-weight: 300;
9+
}

‎docs/components-upgrade.md

+4
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,7 @@
1+
---
2+
title: Upgrading an environment
3+
---
4+
15
# Upgrading an environment
26

37
The ACS installation is made of several components among which:

‎docs/deployment-guide.md

+7-2
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,9 @@
1-
# Deployment Guide
1+
---
2+
title: Deployment guide
3+
nav_order: 3
4+
---
5+
6+
# Deployment guide
27

38
This page describes how to deploy Alfresco Content Services (ACS) using the Ansible playbook found in this project.
49

@@ -8,7 +13,7 @@ guide. If it's your first time with Ansible, please have a read at [Ansible
813
concepts](https://docs.ansible.com/ansible/latest/user_guide/basic_concepts.html)
914
for a brief introduction.
1015

11-
* [Deployment Guide](#deployment-guide)
16+
* [Deployment guide](#deployment-guide)
1217
* [Getting started quickly with Vagrant](#getting-started-quickly-with-vagrant)
1318
* [Getting started](#getting-started)
1419
* [Get the playbook](#get-the-playbook)

‎docs/developer-guide.md

+5
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,8 @@
1+
---
2+
title: Developers guide
3+
layout: default
4+
---
5+
16
# Developers guide
27

38
This page is a developers guide for to popular commands used in the process of

‎docs/favicon.ico

15 KB
Binary file not shown.

‎docs/README.md renamed to ‎docs/index.md

+5-1
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,8 @@
1-
# Alfresco Ansible Deployment
1+
---
2+
title: Home
3+
layout: home
4+
nav_order: 1
5+
---
26

37
[![release](https://img.shields.io/github/v/release/Alfresco/alfresco-ansible-deployment?display_name=release)](https://github.com/Alfresco/alfresco-ansible-deployment/releases/latest)
48
[![community](https://github.com/Alfresco/alfresco-ansible-deployment/actions/workflows/community.yml/badge.svg)](https://github.com/Alfresco/alfresco-ansible-deployment/actions/workflows/community.yml)

‎docs/overview.md

+6-1
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,9 @@
1-
# Documentation
1+
---
2+
title: Overview
3+
nav_order: 2
4+
---
5+
6+
# Overview
27

38
This page provides an overview of Ansible, the project structure and the components deployed.
49

‎docs/playbook-upgrade.md

+5-1
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,8 @@
1-
# Upgrades notes for the playbook
1+
---
2+
title: Upgrading the playbook
3+
---
4+
5+
# Upgrading the playbook
26

37
## Unreleased version
48

‎docs/resources/hyland-alfresco-logos.png

90.8 KB
Loading

‎docs/search-services-deployment-guide.md

+4
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,7 @@
1+
---
2+
title: Deploying Alfresco Search services
3+
---
4+
15
# Deploying Alfresco Search services
26

37
Deploying Alfresco Search service or Insight Engine can be challenging at

‎docs/shared-contentstore.md

+6-2
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,10 @@
1-
# Setting up an Enterprise grade contentstore
1+
---
2+
title: Enterprise grade contentstore
3+
---
4+
5+
# Enterprise grade contentstore
26

3-
In enterprise environment, it's a common requirement to setup a platform so that data is stored on trusted device.
7+
In enterprise environments, it's a common requirement to setup a platform so that data is stored on trusted device.
48

59
## Use cases
610

0 commit comments

Comments
 (0)