From 23abfbf927e3e7943bd0ae154e0ed2be7453fe79 Mon Sep 17 00:00:00 2001 From: Andrew Gracey Date: Wed, 27 Mar 2024 09:34:40 -0700 Subject: [PATCH] Updating repo readme to reflect change to asciidoc (#132) * Removing old build scripts * adding live content back in --- README.md | 28 +++++++++++++++++++--------- 1 file changed, 19 insertions(+), 9 deletions(-) diff --git a/README.md b/README.md index a2ac9ae0..fe11080f 100644 --- a/README.md +++ b/README.md @@ -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 +``` \ No newline at end of file