Rocky Enterprise Software Foundation - Community Team Wiki https://community.rocky.page
Go to file
Neil Hanlon 631e7d2a3d
mkdocs build / build (push) Successful in 43s Details
change compose stack name
2024-02-19 16:59:40 -05:00
.github/workflows Merge remote-tracking branch 'template/main' into HEAD 2024-02-14 18:23:06 -05:00
docs fix trailing whitespace 2024-02-19 16:58:23 -05:00
.gitignore fix trailing whitespace 2024-02-19 16:58:23 -05:00
Containerfile update template, add dev container 2024-02-14 18:12:15 -05:00
LICENSE Init of wiki template 2023-04-04 18:50:34 -04:00
README.md fix url 2024-02-14 18:25:24 -05:00
docker-compose.yml change compose stack name 2024-02-19 16:59:40 -05:00
mkdocs.yml update theme 2024-02-14 20:31:59 -05:00
requirements.txt update template, add dev container 2024-02-14 18:12:15 -05:00

README.md

RESF Community Team Wiki

@TODO - fill in :)

Continuous Integration / Continuous Deployment

Actions Runner executes workflow to publish to https://community.rocky.page on push to main.

Building Locally

In order to build this wiki locally, a docker-compose configuration and container file are supplied which when invoked, will launch mkdocs' development server in a container bound to port 8000 and will live-reload when changes are made to the wiki files.

To run the containers on your system, invoke podman or docker compose like so:

podman-compose -f docker-compose.yml up -d

The container will build and then launch itself. Afterwards, you should be able to view the wiki content at http://localhost:8000.

The compose file accepts a build argument if you need to run it on a different port. For example, to bind to port 8080 on your local machine:

podman-compose -f docker-compose --build-arg PORT=8080 up -d

Project layout

mkdocs.yml    # The configuration file.
README.md     # This file.
docs/
    index.md  # The documentation homepage.
    ...       # Other markdown pages, images and other files.