POC: [M3-7538] - Cloud Manager GH Pages Docs #9960
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,3 @@ | ||
| .jekyll-cache | ||
| .sass-cache | ||
| _site |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,3 +1,7 @@ | ||
| --- | ||
| nav_order: 3 | ||
| --- | ||
|
|
||
| # Contributing | ||
|
|
||
| Thanks for your interest in contributing to the Linode Cloud Manager! | ||
|
|
||
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,3 +1,7 @@ | ||
| --- | ||
| nav_order: 2 | ||
| --- | ||
|
|
||
| # Getting Started | ||
|
|
||
| ## Using the getting_started.sh script | ||
|
|
||
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,6 @@ | ||
| source 'https://rubygems.org' | ||
|
|
||
| gem 'github-pages', group: :jekyll_plugins | ||
| gem "just-the-docs", "0.7.0" # pinned to latest release for security purposes | ||
|
|
||
| gem "webrick", "~> 1.7" |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,279 @@ | ||
| GEM | ||
| remote: https://rubygems.org/ | ||
| specs: | ||
| activesupport (7.1.2) | ||
| base64 | ||
| bigdecimal | ||
| concurrent-ruby (~> 1.0, >= 1.0.2) | ||
| connection_pool (>= 2.2.5) | ||
| drb | ||
| i18n (>= 1.6, < 2) | ||
| minitest (>= 5.1) | ||
| mutex_m | ||
| tzinfo (~> 2.0) | ||
| addressable (2.8.5) | ||
| public_suffix (>= 2.0.2, < 6.0) | ||
| base64 (0.2.0) | ||
| bigdecimal (3.1.4) | ||
| coffee-script (2.4.1) | ||
| coffee-script-source | ||
| execjs | ||
| coffee-script-source (1.11.1) | ||
| colorator (1.1.0) | ||
| commonmarker (0.23.10) | ||
| concurrent-ruby (1.2.2) | ||
| connection_pool (2.4.1) | ||
| dnsruby (1.70.0) | ||
| simpleidn (~> 0.2.1) | ||
| drb (2.2.0) | ||
| ruby2_keywords | ||
| em-websocket (0.5.3) | ||
| eventmachine (>= 0.12.9) | ||
| http_parser.rb (~> 0) | ||
| ethon (0.16.0) | ||
| ffi (>= 1.15.0) | ||
| eventmachine (1.2.7) | ||
| execjs (2.9.1) | ||
| faraday (2.7.12) | ||
| base64 | ||
| faraday-net_http (>= 2.0, < 3.1) | ||
| ruby2_keywords (>= 0.0.4) | ||
| faraday-net_http (3.0.2) | ||
| ffi (1.16.3) | ||
| forwardable-extended (2.6.0) | ||
| gemoji (3.0.1) | ||
| github-pages (228) | ||
| github-pages-health-check (= 1.17.9) | ||
| jekyll (= 3.9.3) | ||
| jekyll-avatar (= 0.7.0) | ||
| jekyll-coffeescript (= 1.1.1) | ||
| jekyll-commonmark-ghpages (= 0.4.0) | ||
| jekyll-default-layout (= 0.1.4) | ||
| jekyll-feed (= 0.15.1) | ||
| jekyll-gist (= 1.5.0) | ||
| jekyll-github-metadata (= 2.13.0) | ||
| jekyll-include-cache (= 0.2.1) | ||
| jekyll-mentions (= 1.6.0) | ||
| jekyll-optional-front-matter (= 0.3.2) | ||
| jekyll-paginate (= 1.1.0) | ||
| jekyll-readme-index (= 0.3.0) | ||
| jekyll-redirect-from (= 0.16.0) | ||
| jekyll-relative-links (= 0.6.1) | ||
| jekyll-remote-theme (= 0.4.3) | ||
| jekyll-sass-converter (= 1.5.2) | ||
| jekyll-seo-tag (= 2.8.0) | ||
| jekyll-sitemap (= 1.4.0) | ||
| jekyll-swiss (= 1.0.0) | ||
| jekyll-theme-architect (= 0.2.0) | ||
| jekyll-theme-cayman (= 0.2.0) | ||
| jekyll-theme-dinky (= 0.2.0) | ||
| jekyll-theme-hacker (= 0.2.0) | ||
| jekyll-theme-leap-day (= 0.2.0) | ||
| jekyll-theme-merlot (= 0.2.0) | ||
| jekyll-theme-midnight (= 0.2.0) | ||
| jekyll-theme-minimal (= 0.2.0) | ||
| jekyll-theme-modernist (= 0.2.0) | ||
| jekyll-theme-primer (= 0.6.0) | ||
| jekyll-theme-slate (= 0.2.0) | ||
| jekyll-theme-tactile (= 0.2.0) | ||
| jekyll-theme-time-machine (= 0.2.0) | ||
| jekyll-titles-from-headings (= 0.5.3) | ||
| jemoji (= 0.12.0) | ||
| kramdown (= 2.3.2) | ||
| kramdown-parser-gfm (= 1.1.0) | ||
| liquid (= 4.0.4) | ||
| mercenary (~> 0.3) | ||
| minima (= 2.5.1) | ||
| nokogiri (>= 1.13.6, < 2.0) | ||
| rouge (= 3.26.0) | ||
| terminal-table (~> 1.4) | ||
| github-pages-health-check (1.17.9) | ||
| addressable (~> 2.3) | ||
| dnsruby (~> 1.60) | ||
| octokit (~> 4.0) | ||
| public_suffix (>= 3.0, < 5.0) | ||
| typhoeus (~> 1.3) | ||
| html-pipeline (2.14.3) | ||
| activesupport (>= 2) | ||
| nokogiri (>= 1.4) | ||
| http_parser.rb (0.8.0) | ||
| i18n (1.14.1) | ||
| concurrent-ruby (~> 1.0) | ||
| jekyll (3.9.3) | ||
| addressable (~> 2.4) | ||
| colorator (~> 1.0) | ||
| em-websocket (~> 0.5) | ||
| i18n (>= 0.7, < 2) | ||
| jekyll-sass-converter (~> 1.0) | ||
| jekyll-watch (~> 2.0) | ||
| kramdown (>= 1.17, < 3) | ||
| liquid (~> 4.0) | ||
| mercenary (~> 0.3.3) | ||
| pathutil (~> 0.9) | ||
| rouge (>= 1.7, < 4) | ||
| safe_yaml (~> 1.0) | ||
| jekyll-avatar (0.7.0) | ||
| jekyll (>= 3.0, < 5.0) | ||
| jekyll-coffeescript (1.1.1) | ||
| coffee-script (~> 2.2) | ||
| coffee-script-source (~> 1.11.1) | ||
| jekyll-commonmark (1.4.0) | ||
| commonmarker (~> 0.22) | ||
| jekyll-commonmark-ghpages (0.4.0) | ||
| commonmarker (~> 0.23.7) | ||
| jekyll (~> 3.9.0) | ||
| jekyll-commonmark (~> 1.4.0) | ||
| rouge (>= 2.0, < 5.0) | ||
| jekyll-default-layout (0.1.4) | ||
| jekyll (~> 3.0) | ||
| jekyll-feed (0.15.1) | ||
| jekyll (>= 3.7, < 5.0) | ||
| jekyll-gist (1.5.0) | ||
| octokit (~> 4.2) | ||
| jekyll-github-metadata (2.13.0) | ||
| jekyll (>= 3.4, < 5.0) | ||
| octokit (~> 4.0, != 4.4.0) | ||
| jekyll-include-cache (0.2.1) | ||
| jekyll (>= 3.7, < 5.0) | ||
| jekyll-mentions (1.6.0) | ||
| html-pipeline (~> 2.3) | ||
| jekyll (>= 3.7, < 5.0) | ||
| jekyll-optional-front-matter (0.3.2) | ||
| jekyll (>= 3.0, < 5.0) | ||
| jekyll-paginate (1.1.0) | ||
| jekyll-readme-index (0.3.0) | ||
| jekyll (>= 3.0, < 5.0) | ||
| jekyll-redirect-from (0.16.0) | ||
| jekyll (>= 3.3, < 5.0) | ||
| jekyll-relative-links (0.6.1) | ||
| jekyll (>= 3.3, < 5.0) | ||
| jekyll-remote-theme (0.4.3) | ||
| addressable (~> 2.0) | ||
| jekyll (>= 3.5, < 5.0) | ||
| jekyll-sass-converter (>= 1.0, <= 3.0.0, != 2.0.0) | ||
| rubyzip (>= 1.3.0, < 3.0) | ||
| jekyll-sass-converter (1.5.2) | ||
| sass (~> 3.4) | ||
| jekyll-seo-tag (2.8.0) | ||
| jekyll (>= 3.8, < 5.0) | ||
| jekyll-sitemap (1.4.0) | ||
| jekyll (>= 3.7, < 5.0) | ||
| jekyll-swiss (1.0.0) | ||
| jekyll-theme-architect (0.2.0) | ||
| jekyll (> 3.5, < 5.0) | ||
| jekyll-seo-tag (~> 2.0) | ||
| jekyll-theme-cayman (0.2.0) | ||
| jekyll (> 3.5, < 5.0) | ||
| jekyll-seo-tag (~> 2.0) | ||
| jekyll-theme-dinky (0.2.0) | ||
| jekyll (> 3.5, < 5.0) | ||
| jekyll-seo-tag (~> 2.0) | ||
| jekyll-theme-hacker (0.2.0) | ||
| jekyll (> 3.5, < 5.0) | ||
| jekyll-seo-tag (~> 2.0) | ||
| jekyll-theme-leap-day (0.2.0) | ||
| jekyll (> 3.5, < 5.0) | ||
| jekyll-seo-tag (~> 2.0) | ||
| jekyll-theme-merlot (0.2.0) | ||
| jekyll (> 3.5, < 5.0) | ||
| jekyll-seo-tag (~> 2.0) | ||
| jekyll-theme-midnight (0.2.0) | ||
| jekyll (> 3.5, < 5.0) | ||
| jekyll-seo-tag (~> 2.0) | ||
| jekyll-theme-minimal (0.2.0) | ||
| jekyll (> 3.5, < 5.0) | ||
| jekyll-seo-tag (~> 2.0) | ||
| jekyll-theme-modernist (0.2.0) | ||
| jekyll (> 3.5, < 5.0) | ||
| jekyll-seo-tag (~> 2.0) | ||
| jekyll-theme-primer (0.6.0) | ||
| jekyll (> 3.5, < 5.0) | ||
| jekyll-github-metadata (~> 2.9) | ||
| jekyll-seo-tag (~> 2.0) | ||
| jekyll-theme-slate (0.2.0) | ||
| jekyll (> 3.5, < 5.0) | ||
| jekyll-seo-tag (~> 2.0) | ||
| jekyll-theme-tactile (0.2.0) | ||
| jekyll (> 3.5, < 5.0) | ||
| jekyll-seo-tag (~> 2.0) | ||
| jekyll-theme-time-machine (0.2.0) | ||
| jekyll (> 3.5, < 5.0) | ||
| jekyll-seo-tag (~> 2.0) | ||
| jekyll-titles-from-headings (0.5.3) | ||
| jekyll (>= 3.3, < 5.0) | ||
| jekyll-watch (2.2.1) | ||
| listen (~> 3.0) | ||
| jemoji (0.12.0) | ||
| gemoji (~> 3.0) | ||
| html-pipeline (~> 2.2) | ||
| jekyll (>= 3.0, < 5.0) | ||
| just-the-docs (0.7.0) | ||
| jekyll (>= 3.8.5) | ||
| jekyll-include-cache | ||
| jekyll-seo-tag (>= 2.0) | ||
| rake (>= 12.3.1) | ||
| kramdown (2.3.2) | ||
| rexml | ||
| kramdown-parser-gfm (1.1.0) | ||
| kramdown (~> 2.0) | ||
| liquid (4.0.4) | ||
| listen (3.8.0) | ||
| rb-fsevent (~> 0.10, >= 0.10.3) | ||
| rb-inotify (~> 0.9, >= 0.9.10) | ||
| mercenary (0.3.6) | ||
| minima (2.5.1) | ||
| jekyll (>= 3.5, < 5.0) | ||
| jekyll-feed (~> 0.9) | ||
| jekyll-seo-tag (~> 2.1) | ||
| minitest (5.20.0) | ||
| mutex_m (0.2.0) | ||
| nokogiri (1.15.5-arm64-darwin) | ||
| racc (~> 1.4) | ||
| octokit (4.25.1) | ||
| faraday (>= 1, < 3) | ||
| sawyer (~> 0.9) | ||
| pathutil (0.16.2) | ||
| forwardable-extended (~> 2.6) | ||
| public_suffix (4.0.7) | ||
| racc (1.7.3) | ||
| rake (13.1.0) | ||
| rb-fsevent (0.11.2) | ||
| rb-inotify (0.10.1) | ||
| ffi (~> 1.0) | ||
| rexml (3.2.6) | ||
| rouge (3.26.0) | ||
| ruby2_keywords (0.0.5) | ||
| rubyzip (2.3.2) | ||
| 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.9.2) | ||
| addressable (>= 2.3.5) | ||
| faraday (>= 0.17.3, < 3) | ||
| simpleidn (0.2.1) | ||
| unf (~> 0.1.4) | ||
| terminal-table (1.8.0) | ||
| unicode-display_width (~> 1.1, >= 1.1.1) | ||
| typhoeus (1.4.1) | ||
| ethon (>= 0.9.0) | ||
| tzinfo (2.0.6) | ||
| concurrent-ruby (~> 1.0) | ||
| unf (0.1.4) | ||
| unf_ext | ||
| unf_ext (0.0.9.1) | ||
| unicode-display_width (1.8.0) | ||
| webrick (1.8.1) | ||
|
|
||
| PLATFORMS | ||
| arm64-darwin-22 | ||
|
|
||
| DEPENDENCIES | ||
| github-pages | ||
| just-the-docs (= 0.7.0) | ||
| webrick (~> 1.7) | ||
|
|
||
| BUNDLED WITH | ||
| 2.3.26 |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change | ||||
|---|---|---|---|---|---|---|
| @@ -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). | ||||||
|
There was a problem hiding this comment. I think you meant "tooling" instead of "tolling". |
||||||
|
|
||||||
| This should be done from the /docs/ directory. | ||||||
|
There was a problem hiding this comment.
Suggested change
|
||||||
|
|
||||||
| 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. | ||||||
|
There was a problem hiding this comment.
Suggested change
|
||||||
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,8 @@ | ||
| # CONTRIBUTING is a reserved file name for GitHub, so we need to explicitly include it here | ||
| include: ['CONTRIBUTING.md'] | ||
|
|
||
| # Our theme and its customizations | ||
| remote_theme: just-the-docs/just-the-docs | ||
| color_scheme: akamai | ||
| favicon_ico: '/assets/images/favicon.ico' | ||
| logo: '/assets/images/akamai-logo.png' |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,3 @@ | ||
| <footer class="site-footer"> | ||
| Copyright Akamai Technologies, Inc. ©{{ site.time | date: "%Y"}} | ||
| </footer> |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,9 @@ | ||
| // For variable overrides, see https://github.com/just-the-docs/just-the-docs/blob/main/_sass/support/_variables.scss | ||
|
|
||
| $link-color: rgb(37, 117, 208); | ||
|
|
||
| .nav-list li a { | ||
| line-height: 1.3 !important; | ||
| padding-bottom: 0.5rem !important; | ||
| padding-top: 0.5rem !important; | ||
| } |
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file not shown.
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,3 +1,7 @@ | ||
| --- | ||
| parent: Development Guide | ||
| --- | ||
|
|
||
| # Managing State | ||
|
|
||
| ## Component State | ||
|
|
||
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,3 +1,7 @@ | ||
| --- | ||
| parent: Development Guide | ||
| --- | ||
|
|
||
| # Component Library | ||
|
|
||
| ## Material-UI | ||
|
|
||
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.