Skip to content

Commit

Permalink
docs(contribution): Refactor website building, include custom page title
Browse files Browse the repository at this point in the history
  • Loading branch information
vladimir-slavov-iob committed Oct 23, 2024
1 parent 20f4a9b commit 00c9ebd
Showing 1 changed file with 30 additions and 5 deletions.
35 changes: 30 additions & 5 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -28,13 +28,27 @@ https://www.eclipse.org/projects/handbook/#resources-commit

* Fork the repository on GitHub.
* Create a new branch for your changes.
* Install docusaurus: https://docusaurus.io/docs/installation
* Make your changes following the code style guide (see Code Style Guide section above).
* When you create new files make sure you include a proper license header at the top of the file (see License Header section below).
* Test the docusaurus website locally by
- npm run build and
- npm run serve
in the "website" subfolder
* The Docusaurus website should be tested locally. To do so:
* requirements:

```text
node >= 18.0.0
```

* in the /website subdirectory, install the node dependencies by running:

```bash
npm install
```

* then run:

```bash
npm run build && npm run serve
```

* Commit your changes into that branch.
* Use descriptive and meaningful commit messages. Start the first line of the commit message with the issue number and title e.g. `[#9517] Fixed typo in the description`.
* Squash multiple commits that are related to each other semantically into a single one.
Expand Down Expand Up @@ -76,6 +90,17 @@ For content in Markdown / React
```
Please adjust the comment character to the specific file format.

**Note**: Adding a Copyright header intereferes with the way Docusaurus determines the default title of the page.
To set a custom title, use the page metadata functionality with the syntax

```text
---
title: [page-title]
---
```

at the top of the file.

## Submitting the Changes

Submit a pull request via the normal GitHub UI.
Expand Down

0 comments on commit 00c9ebd

Please sign in to comment.