IntenseWebs/opentofu
3
0
Fork 0
mirror of https://github.com/opentofu/opentofu.git synced 2024-12-24 16:10:46 -06:00
Code Issues Packages Projects Releases Wiki Activity

Enhance the documentation to show how to run the docs website locally (#638)

Browse Source 
Signed-off-by: Serdar Dalgıç <sd@serdardalgic.org>
This commit is contained in:
Serdar Dalgıç 2023-10-04 10:58:55 +02:00 committed by GitHub
parent 3ddf49b606
commit cb7713bc54
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
2 changed files with 7 additions and 26 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

15
Makefile
View File

@ -37,21 +37,6 @@ staticcheck:
exhaustive:
"$(CURDIR)/scripts/exhaustive.sh"
# Run this if working on the website locally to run in watch mode.
.PHONY: website
website:
$(MAKE) -C website website
# Use this if you have run `website/build-local` to use the locally built image.
.PHONY: website/local
website/local:
$(MAKE) -C website website/local
# Run this to generate a new local Docker image.
.PHONY: website/build-local
website/build-local:
$(MAKE) -C website website/build-local
# Run license check
.PHONY: license-check
license-check:

18
website/README.md
View File

@ -8,16 +8,6 @@ You can [submit an issue](https://github.com/opentofu/opentofu/issues/new/choose
Click **Edit this page** at the bottom of any OpenTofu website page to go directly to the associated markdown file in GitHub.
## Validating Content
Content changes are automatically validated against a set of rules as part of the pull request process. If you want to run these checks locally to validate your content before committing your changes, you can run the following command:
```
npm run content-check
```
If the validation fails, actionable error messages will be displayed to help you address detected issues.
## Modifying Sidebar Navigation
You must update the sidebar navigation when you add or delete documentation .mdx files. If you do not update the navigation, the website deploy preview fails.
@ -30,7 +20,13 @@ To update the sidebar navigation, you must edit the appropriate `nav-data.json`
## Previewing Changes
Coming soon: Documenting the development process for the documentation website repo.
Currently, you can preview your changes through the [opentofu/opentofu.org](https://github.com/opentofu/opentofu.org/blob/main/README.md) repository.
Follow the [Getting Started](https://github.com/opentofu/opentofu.org/blob/main/README.md#getting-started) guide.
If you would like to fetch the documentation from another repository and another branch, you can run the make command with REPO_URL and BRANCH arguments before starting the development server:
```
make REPO_URL="<your_forked_repo_url>" BRANCH="<branch_name>"
```
## Deploying Changes