project-documentation-template — Docusaurus Documentation Template

SHA-256: 0e1952b81ebfdf156b10cdd7655380929f599c0c5fc83c716a4fefc8d3a43059

2026-10-01T03:51:00.334Z

# project-documentation-template

This website is built using [Docusaurus](https://docusaurus.io/), a modern static website generator.

The site may be previewed at <https://ibm.github.io/project-documentation-template>.

If you spot any errors or ommisions in the site, please open an issue at [github.com/ibm/project-documentation-template](https://github.com/ibm/project-documentation-template/issues)

> [!NOTE]
> This repo should only be used if you are doing a "large project" that requires it's own Documentation page/site. If you are doing
> "one repo" documentation take a look at something like the "[workshop-template](https://github.com/ibm/workshop-template) for
> single repo documentation.

## BEFORE DOING A PULL REQUEST

1. Make sure you are familiar with how docusaurus builds menus and links to images
2. Make sure there are no relative links to any of the IBM component repositories in your markdown.
3. Fork the website repo and deploy a preview version of your proposed change for reviewers to check. This will make obvious any missed links from step 2


### Installation

```
$ npm install
```

### Local Development

```
$ npm start
```

This command starts a local development server and opens up a browser window. Most changes are reflected live without having to restart the server.

### Making Changes

1. **Fork the Repository**
   - Click the "Fork" button on the <https://github.com/ibm/project-documentation-template> GitHub repo.
   - Clone your fork locally: `git clone https://github.com/YOUR-USERNAME/project-documentation-template.git`

2. **Create a Branch**
   - Create a new branch for your changes: `git checkout -b feature/your-feature-name`
   - Make your changes locally

3. **Commit Your Changes**
   - Stage your changes: `git add .`
   - Commit with sign-off: `git commit -s -m "Your commit message"`
   - Push to your fork: `git push origin feature/your-feature-name`

4. **Open a Pull Request**
   - Go to your fork on GitHub
   - Click "New Pull Request"
   - Select the main branch of ibm/project-documentation-template as the base
   - Fill out the pull request template with details about your changes

### Pull Request Preview

When you open a pull request, a preview of your changes will be automatically generated and deployed. This allows reviewers to see your changes in a live environment before they are merged into the main website.

- The preview URL will be posted as a comment on your pull request
- The preview site will be automatically updated as you push new commits
- The preview will be removed when the pull request is closed

### Code Review Requirements

- **All code changes** must be submitted as pull requests (no direct pushes)
- **All changes** must be reviewed and approved by a maintainer
- **All changes** must pass automated checks and tests
- **Commit messages** should have:
  - Short, descriptive titles
  - Description of why the change was needed
  - Enough detail for someone reviewing git history to understand the scope
- **DCO Sign-off**: All commits must include a valid DCO sign-off line (`Signed-off-by: Name <[email protected]>`)
  - Add automatically with `git commit -s`
  - Required for all contributions per [Developer Certificate of Origin](https://developercertificate.org/)

## License

All source files must include a Copyright and License header. The SPDX license header is
preferred because it can be easily scanned.

If you would like to see the detailed LICENSE click [here](LICENSE).

```text
#
# Copyright IBM Corp. {Year project was created} - {Current Year}
# SPDX-License-Identifier: Apache-2.0
#
```
## Authors

Optionally, you may include a list of authors, though this is redundant with the built-in
GitHub list of contributors.

- Author: New OpenSource IBMer <[email protected]>

[issues]: https://github.com/IBM/repo-template/issues/new