fluxcd
/
website
mirror of https://github.com/fluxcd/website.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity
The Flux website and user documentation
197 Commits 32 Branches 0 Tags 68 MiB
HTML 49.2%
SCSS 26.5%
Python 13.4%
Shell 5.7%
Makefile 3.5%
Other 1.7%
Go to file
Daniel Holbach b0bda191e8 update docs from flux2 main branch 
remove progressbars, drop use of :material-check-bold:

Signed-off-by: Daniel Holbach <daniel@weave.works>
 		2021-04-16 15:37:26 +02:00
.github Apply fixes from Hidde, allow triggering action from UI 2021-01-25 16:04:50 +01:00
assets Piggyback on blog post styling 2021-01-18 14:07:03 +01:00
content/en update docs from flux2 main branch 2021-04-16 15:37:26 +02:00
external-sources/fluxcd we moved the security file to fluxcd/.github 2021-04-06 18:24:12 +02:00
hack we moved the security file to fluxcd/.github 2021-04-06 18:24:12 +02:00
i18n Simple blog template 2020-12-01 12:50:59 +01:00
layouts Update Navbar styling 2021-04-16 15:37:26 +02:00
static update docs from f/flux2 - move bits in the right place 2021-04-16 15:37:26 +02:00
.editorconfig Add editorconfig file 2019-08-13 11:14:53 -07:00
.gitignore Initial site scaffolding and design 2019-08-13 10:47:44 -07:00
LICENSE Initial commit 2019-08-13 11:37:51 -06:00
MAINTAINERS Add MAINTAINERS 2020-10-30 15:22:27 +01:00
Makefile Import content before serving site 2021-01-18 09:24:44 +01:00
README.md explain how docs work 2021-03-08 16:51:44 +01:00
config.toml Fix "Get an Invite" slack link typo 2021-04-07 15:59:04 -04:00
netlify.toml Improve Netlify configuration 2020-11-06 00:27:29 +01:00
package-lock.json Bump autoprefixer from 10.2.4 to 10.2.5 2021-03-08 07:00:09 +00:00
package.json Bump autoprefixer from 10.2.4 to 10.2.5 2021-03-08 07:00:09 +00:00

README.md

fluxcd.io

This repo houses the assets used to build the Flux project's landing page at https://fluxcd.io.

Note: The sources for some of Flux's documentation are housed in the other Flux repositories within https://github.com/fluxcd. Issues and pull requests for this documentation should be registered at that repos.

Project Docs Site Github Source
Flux v1 https://docs.fluxcd.io https://github.com/fluxcd/flux
Helm Operator https://docs.fluxcd.io/projects/helm-operator/ https://github.com/fluxcd/helm-operator
Flux v2 https://toolkit.fluxcd.io https://github.com/fluxcd/flux2

We are in the process of moving everything into this repository: /fluxcd/website. The work can be tracked here: https://github.com/fluxcd/website/issues/76.

How to modify this website

The main landing page of this website can be modified in config.toml.

All other content lives in the content directory:

  • ./content/en/blog contains all blog posts - make sure you update the front-matter for posts to show up correctly.
  • ./external-sources/ defines how files from other repositories are pulled in. We currently do this for Markdown files from the /fluxcd/community repository. (The ./hack/gen-content.sh pulls these in.)

Running the site locally

In order to run the Flux site locally, you need to install:

  • Node.js
  • The Hugo static site generator. Make sure to install the "extended" variant of Hugo with support for the Hugo Pipes feature and to check the netlify.toml configuration file for which version of Hugo you should install.

Once those tools are installed, fetch the assets necessary to run the site:

npm install

Then run the site in "server" mode:

make serve

Navigate to http://localhost:1313 to see the site running in your browser. As you make updates to the site, the browser will immediately update to reflect those changes.

Publishing the site

The Flux website is published automatically by Netlify when changes are pushed to the main branch. The site does not need to be published manually.

Preview builds

When you submit a pull request to this repository, Netlify builds a "deploy preview" of your changes. You can see that preview by clicking on the deploy/netlify link in the pull request window.