crossplane
/
docs
mirror of https://github.com/crossplane/docs.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity
Repo for Crossplane documentation.
911 Commits 4 Branches 8 Tags 39 MiB
SCSS 62.4%
JavaScript 24.5%
HTML 12.9%
Shell 0.2%
Go to file
Pete Lumbis 9ffc43da11
move to markdown file 
Signed-off-by: Pete Lumbis <pete@upbound.io>
 		2022-10-05 11:10:07 -04:00
content update to sync with upstream docs snapshots 2022-10-05 11:10:07 -04:00
static/images move images to static folder for hugo content management 2022-10-05 11:10:02 -04:00
themes/crossplane corrects regex error for pages with 'v' in the URL 2022-10-05 11:10:06 -04:00
.gitignore more comprehensive gitignore including common hugo directories 2022-10-05 11:10:06 -04:00
LICENSE.md move to markdown file 2022-10-05 11:10:07 -04:00
OWNERS.md update OWNERS.md - add plumbis, remove connorchan 2022-09-05 17:46:03 -07:00
README.md Add licenses for this repo 2021-01-06 10:09:16 -08:00
config.yaml hugo configuration file 2022-10-05 11:10:06 -04:00

README.md

Crossplane Site

This is the the source for http://crossplane.io. It is rendered using Jekyll by GitHub Pages. Docs from the main crossplane repo are published here automatically during the main repo CI publish.

To preview and share changes from your fork

It is possible to live preview changes from your fork of this repo, for instance to share your changes for review by others.

After pushing your changes to your fork, make sure that a publishing source is set within the settings of your fork:

  • Navigate to Settings tab, then the Options tab
  • Scroll down to GitHub Pages section
  • Select a Branch (e.g. the branch of your fork you just pushed to) for the Source section
  • Click Save

Within a small amount of time, after your site has been built and published, you'll be able to see and share a live preview with others. The URL will be similar to the following, but with your GitHub user name:

Full instructions can be found in the GitHub Pages docs.

To develop locally

This runs locally watching for changes and live reloading.

brew install npm

make run

Open http://localhost:4000 in your browser.

To run locally with local crossplane docs

Ensure $(GOPATH)/src/github.com/crossplane/crossplane/docs is present.

brew install npm

make run_docs_local

To run with --incremental for faster editing:

make run_docs_local_incremental

Note: --incremental is experimental, and sometimes gets stuck: https://jekyllrb.com/docs/configuration/incremental-regeneration/

Open http://localhost:4000 in your browser.

License

The source code in this repository is licensed under the Apache 2.0 license.

The documentation is distributed under CC-BY-4.0.