Setup Local Environment
This document describes how to set up your local environment for contributing to United Manufacturing Hub documentation website.
Documentation
Learn how to contribute to the United Manufacturing Hub documentation.
2 minute read
Welcome
Welcome to the United Manufacturing Hub documentation! We’re excited that you want to contribute to the project.
The first place to start is the Getting Started With Contributing page. It provides a high-level overview of the contribution process.
Once you’re familiar with the contribution process, you can prepare for your first contribution by reading the documents in this section.
United Manufacturing Hub documentation contributors:
- Improve existing content
- Create new content
- Translate the documentation
- Manage and publish the documentation parts of the United Manufacturing Hub release cycle
Your first contribution
You can prepare for your first contribution by reviewing several steps beforehand. The next figure outlines the steps nad the details to follow.
flowchart LR
subgraph second[First Contribution]
direction TB
S[ ] -.-
G[Review PRs from other
UMH members] --> A[Check umh.docs.umh.app
issues list for good
first PRs] --> B[Open a PR!!] end subgraph first[Suggested Prep] direction TB T[ ] -.- D[Read contribution overview] -->E[Read UMH content
and style guides] E --> F[Learn about Hugo page
content types
and shortcodes] end first ----> second classDef grey fill:#dddddd,stroke:#ffffff,stroke-width:px,color:#000000, font-size:15px; classDef white fill:#ffffff,stroke:#000,stroke-width:px,color:#000,font-weight:bold classDef spacewhite fill:#ffffff,stroke:#fff,stroke-width:0px,color:#000 class A,B,D,E,F,G grey class S,T spacewhite class first,second white
UMH members] --> A[Check umh.docs.umh.app
issues list for good
first PRs] --> B[Open a PR!!] end subgraph first[Suggested Prep] direction TB T[ ] -.- D[Read contribution overview] -->E[Read UMH content
and style guides] E --> F[Learn about Hugo page
content types
and shortcodes] end first ----> second classDef grey fill:#dddddd,stroke:#ffffff,stroke-width:px,color:#000000, font-size:15px; classDef white fill:#ffffff,stroke:#000,stroke-width:px,color:#000,font-weight:bold classDef spacewhite fill:#ffffff,stroke:#fff,stroke-width:0px,color:#000 class A,B,D,E,F,G grey class S,T spacewhite class first,second white
flowchart LR
subgraph second[First Contribution]
direction TB
S[ ] -.-
G[Review PRs from other
UMH members] --> A[Check umh.docs.umh.app
issues list for good
first PRs] --> B[Open a PR!!] end subgraph first[Suggested Prep] direction TB T[ ] -.- D[Read contribution overview] -->E[Read UMH content
and style guides] E --> F[Learn about Hugo page
content types
and shortcodes] end first ----> second classDef grey fill:#dddddd,stroke:#ffffff,stroke-width:px,color:#000000, font-size:15px; classDef white fill:#ffffff,stroke:#000,stroke-width:px,color:#000,font-weight:bold classDef spacewhite fill:#ffffff,stroke:#fff,stroke-width:0px,color:#000 class A,B,D,E,F,G grey class S,T spacewhite class first,second white
UMH members] --> A[Check umh.docs.umh.app
issues list for good
first PRs] --> B[Open a PR!!] end subgraph first[Suggested Prep] direction TB T[ ] -.- D[Read contribution overview] -->E[Read UMH content
and style guides] E --> F[Learn about Hugo page
content types
and shortcodes] end first ----> second classDef grey fill:#dddddd,stroke:#ffffff,stroke-width:px,color:#000000, font-size:15px; classDef white fill:#ffffff,stroke:#000,stroke-width:px,color:#000,font-weight:bold classDef spacewhite fill:#ffffff,stroke:#fff,stroke-width:0px,color:#000 class A,B,D,E,F,G grey class S,T spacewhite class first,second white
- Read the Contribution overview to learn about the different ways you can contribute.
- Check united-manufacturing-hub/umh.docs.umh.app issues list for issues that make good entry points.
- Open a pull request using GitHub to existing documentation and learn more about filing issues in GitHub.
- Get an insight on how to setup your local environment.
- Read how to write a new topic and the UMH style overview to learn about writing documentation.
- Discover how to localize the documentation.
Write a new topic
This page shows how to create a new topic for the United Manufacturing Hub docs.
Style Overview
This section provides guidance on writing style, content formatting and organization, and using Hugo customizations specific to UMH documentation.
Localizing UMH documentation
This page shows you how to localize the docs for a different language.
Versioning Documentation
This page describe how to version the documentation website.
Last modified April 19, 2024: add tag error tracing to tag browser feature list (#287) (ee24bb5)