From cfdfa81c60bdfaa8d1cc7045f577c1bcae3779c9 Mon Sep 17 00:00:00 2001 From: Alban Bailly Date: Tue, 5 Dec 2023 14:03:34 -0500 Subject: [PATCH] Add development doc --- docs/Gemfile | 2 +- docs/Gemfile.lock | 2 +- docs/README.md | 19 +++++++++++++++++++ docs/_config.yml | 4 +++- 4 files changed, 24 insertions(+), 3 deletions(-) create mode 100644 docs/README.md diff --git a/docs/Gemfile b/docs/Gemfile index e0f799a89e2..e85bc1f6e43 100644 --- a/docs/Gemfile +++ b/docs/Gemfile @@ -1,6 +1,6 @@ source 'https://rubygems.org' gem 'github-pages', group: :jekyll_plugins -gem "just-the-docs" +gem "just-the-docs", "0.7.0" # pinned to latest release for security purposes gem "webrick", "~> 1.7" \ No newline at end of file diff --git a/docs/Gemfile.lock b/docs/Gemfile.lock index 978c8d6aefc..972f01faed5 100644 --- a/docs/Gemfile.lock +++ b/docs/Gemfile.lock @@ -272,7 +272,7 @@ PLATFORMS DEPENDENCIES github-pages - just-the-docs + just-the-docs (= 0.7.0) webrick (~> 1.7) BUNDLED WITH diff --git a/docs/README.md b/docs/README.md new file mode 100644 index 00000000000..be9433536c2 --- /dev/null +++ b/docs/README.md @@ -0,0 +1,19 @@ +# Akamai Cloud Manager Documentation + +This doc builder uses default GitHub pages and its Jekyll site builder to deploy documentation pages to [https://linode.github.io/manager](https://linode.github.io/manager). + +It automatically get deployed when we release to `master`. +It can be customized easily (styles, templates) via updating its configuration and templates (see [documentation](https://just-the-docs.com/docs/configuration)) + +## Local Development + +In order to develop locally, start by setting up your tolling locally by following the steps on this [page](https://docs.github.com/en/pages/setting-up-a-github-pages-site-with-jekyll/testing-your-github-pages-site-locally-with-jekyll). + +This should be done from the /docs/ directory. + +Once your local site is running, you can: + +- modify the styles by updating `_sass/color_schemes/akamai.scss`. +- modify layouts by adding/updating HTML templates to the `_includes` directory. + +See [https://just-the-docs.com/docs/customization](https://just-the-docs.com/docs/customization) for mor info. diff --git a/docs/_config.yml b/docs/_config.yml index 4c210d35cbd..3b5cad3cf18 100644 --- a/docs/_config.yml +++ b/docs/_config.yml @@ -1,5 +1,7 @@ +# CONTRIBUTING is a reserved file name for GitHub, so we need to explicitly include it here include: ['CONTRIBUTING.md'] -# theme: just-the-docs + +# Our theme and its customizations remote_theme: just-the-docs/just-the-docs color_scheme: akamai favicon_ico: '/assets/images/favicon.ico'