-
Notifications
You must be signed in to change notification settings - Fork 4
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Signed-off-by: Oleksandr Dubenko <oldubenko@microsoft.com>
- Loading branch information
Showing
724 changed files
with
45,437 additions
and
30,472 deletions.
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
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,20 @@ | ||
| # Dependencies | ||
| /node_modules | ||
|
|
||
| # Production | ||
| /build | ||
|
|
||
| # Generated files | ||
| .docusaurus | ||
| .cache-loader | ||
|
|
||
| # Misc | ||
| .DS_Store | ||
| .env.local | ||
| .env.development.local | ||
| .env.test.local | ||
| .env.production.local | ||
|
|
||
| npm-debug.log* | ||
| yarn-debug.log* | ||
| yarn-error.log* |
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,108 +1,41 @@ | ||
| # Headlamp Website | ||
| # Website | ||
|
|
||
| Headlamp's website is built with [Hugo](https://gohugo.io/). | ||
| This website is built using [Docusaurus](https://docusaurus.io/), a modern static website generator. | ||
|
|
||
| ## Installing Hugo | ||
|
|
||
| You should install Hugo Extended instead of the regular Hugo version. | ||
|
|
||
| So download [Hugo Extended](https://github.com/gohugoio/hugo/releases) | ||
| from the releases page, and/or follow | ||
| [these instructions](https://gohugo.io/getting-started/installing/) | ||
| in order to install it. | ||
|
|
||
| ## Adding content | ||
|
|
||
| Currently, you'll need to edit the text files under `content` in this repo to modify the site. | ||
|
|
||
| ### Blog content | ||
|
|
||
| In order to add content for the blog you can use the `hugo new` command. The format is as follow. | ||
|
|
||
| `hugo new blog/YEAR-MONTH-DAY-example-content/index.md` | ||
|
|
||
| The following command will create a new blog post with the [front matter](https://gohugo.io/content-management/front-matter/) defined in the default [archetype](https://gohugo.io/content-management/archetypes/) from the `./archetype` directory. | ||
|
|
||
| The default front matter almost always needs to be modified to a category and tags. Here's an example. | ||
| ### Installation | ||
|
|
||
| ``` | ||
| --- | ||
| title: "Example Content" | ||
| date: 2018-10-26T03:51:27+02:00 | ||
| draft: true | ||
| tags: | ||
| - tag1 | ||
| - tag1 | ||
| categories: | ||
| - Announcement | ||
| --- | ||
| $ yarn | ||
| ``` | ||
|
|
||
| *TODO: Add more content sections (events, job postings, etc.)* | ||
|
|
||
| ## Testing | ||
|
|
||
| You should always test your changes locally before creating a pull request. Once you do createi a branch or a pull request, we use Netlify to create previes of the changes so that reviewers and yourself can easily review the changes. | ||
|
|
||
| ### Testing locally | ||
|
|
||
| To test locally run the following command. | ||
| ### Local Development | ||
|
|
||
| `make run` | ||
|
|
||
| The above command will run a server with the the site available at `http://localhost:1313`. It will also watch for any changes made to the site and regenerate and reload the site when changes are detected. In addition, it disables some caching that can sometimes have confusing results. | ||
|
|
||
| ### Testing Pull requests | ||
|
|
||
| Each pull request will run some checks and create a new preview of the changes that can be access by clicking on the Github pull request status section. | ||
|
|
||
| ### Testing documentation locally | ||
|
|
||
| If you are working on documentation and would like to see the changes | ||
| be reflected in a local run of the website, then you need to generate a | ||
| module to import the docs and run the website locally with it. | ||
|
|
||
| You can use the `tools/preview_docs.sh` script for conveniently generating | ||
| an import module, e.g.: | ||
| ``` | ||
| $ yarn start | ||
| ``` | ||
|
|
||
| `./tools/preview_docs.sh ../headlamp/docs new_latest` | ||
| This command starts a local development server and opens up a browser window. Most changes are reflected live without having to restart the server. | ||
|
|
||
| (this creates a `tmp_modules.yaml`) | ||
| ### Build | ||
|
|
||
| and then start the local server again with `make run`. | ||
| ``` | ||
| $ yarn build | ||
| ``` | ||
|
|
||
| You can then view the changes in the `new_latest` version of the docs by accessing the site at the server. | ||
| ex. `http://localhost:1313/docs/new_latest`. | ||
| This command generates static content into the `build` directory and can be served using any static contents hosting service. | ||
|
|
||
| ## Changing the published documentation | ||
| ### Deployment | ||
|
|
||
| The documentation is set under `params.docs` in [config.yaml](./config.yaml) and | ||
| should look similar to: | ||
| Using SSH: | ||
|
|
||
| ``` | ||
| github_edit_url: https://github.com/kinvolk/headlamp/edit/main/docs/ | ||
| issues_url: https://github.com/kinvolk/kinvolk/issues/new?labels=kind/docs | ||
| external_docs: | ||
| - repo: https://github.com/kinvolk/headlamp.git | ||
| name: "latest" | ||
| branch: "main" | ||
| dir: "docs" | ||
| $ USE_SSH=true yarn deploy | ||
| ``` | ||
|
|
||
| If you want to add a new version of the documentation, this can be done by adding a new entry to external_docs: | ||
| Not using SSH: | ||
|
|
||
| ``` | ||
| external_docs: | ||
| - repo: https://github.com/kinvolk/headlamp.git | ||
| name: "latest" | ||
| branch: "main" | ||
| dir: "docs" | ||
| - repo: https://github.com/kinvolk/headlamp.git | ||
| name: "old" | ||
| branch: "tag-1.2.3" | ||
| dir: "docs" | ||
| $ GIT_USER=<Your GitHub username> yarn deploy | ||
| ``` | ||
|
|
||
| This will pull the docs that were versioned by the `tag-1.2.3` and place them under a version called `old`. | ||
|
|
||
| By default, the first version in the list of `external_docs` is considered to be | ||
| the latest version and so it is the one linked to automatically in the site. | ||
| If you are using GitHub pages for hosting, this command is a convenient way to build the website and push to the `gh-pages` branch. |
Binary file not shown.
This file was deleted.
Oops, something went wrong.
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 @@ | ||
| module.exports = { | ||
| presets: [require.resolve('@docusaurus/core/lib/babel/preset')], | ||
| }; |
File renamed without changes
File renamed without changes
File renamed without changes
File renamed without changes
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
File renamed without changes
File renamed without changes
File renamed without changes
File renamed without changes
File renamed without changes
File renamed without changes
Oops, something went wrong.