forked from suse-edge/suse-edge.github.io
-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Updating repo readme to reflect change to asciidoc (suse-edge#132)
* Removing old build scripts * adding live content back in
- Loading branch information
Showing
1 changed file
with
19 additions
and
9 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
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,19 +1,29 @@ | ||
# SUSE Edge website | ||
|
||
Available at [https://suse-edge.github.io/](https://suse-edge.github.io/) | ||
The latest version of our docs can be found at https://suse-edge.github.io/id-suse-edge-documentation.html | ||
|
||
|
||
Built using [Docusaurus 2](https://docusaurus.io/) | ||
|
||
## How to test/build locally | ||
|
||
If you are contributing to our documentation, you can locally render the content using one of these methods. | ||
|
||
With docker/podman: | ||
|
||
```bash | ||
npm ci | ||
npm run start | ||
podman run -it --rm -v $PWD/:/docs/ registry.opensuse.org/home/atgracey/cnbp/containers/builder:latest bash -c 'cd /docs/asciidoc; daps -d DC-edge html' | ||
|
||
cd asciidoc/build/edge/html/edge; python -m http.server | ||
``` | ||
|
||
## Some notes | ||
With [Pack](https://buildpacks.io/docs/for-platform-operators/how-to/integrate-ci/pack/): | ||
```bash | ||
pack build edge-docs --path asciidoc --builder registry.opensuse.org/home/atgracey/cnbp/containers/builder:latest -e BP_DC_FILE=DC-edge | ||
|
||
podman run -d -p 8080:8080 edge-docs | ||
``` | ||
|
||
* Sidebar is custom and semi-generated (see [the official docs](https://docusaurus.io/docs/sidebar/autogenerated)) | ||
* We are running it using [Docs only mode](https://docusaurus.io/docs/docs-introduction#docs-only-mode) | ||
* It is served via GitHub Pages (see [.github/workflows](.github/workflows)) | ||
* We are using the [elemental docs repository](https://github.com/rancher/elemental-docs) as inspiration 🙂 | ||
With [Epinio](epinio.io): | ||
```bash | ||
epinio push -n docs --builder-image registry.opensuse.org/home/atgracey/cnbp/containers/builder:latest -e BP_DC_FILE=DC-edge | ||
``` |