Skip to content

Commit 49f3d30

Browse files
authored
Revise contributing guidelines for documentation
Updated the contributing guidelines to focus on documentation style and review processes.
1 parent 8707012 commit 49f3d30

File tree

1 file changed

+2
-10
lines changed

1 file changed

+2
-10
lines changed

best_practices.md

Lines changed: 2 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -1,14 +1,6 @@
1-
# Contributing to Port's documentation
1+
# Port documentation style guide
22

3-
Here you can find resources and guidelines on how to contribute to Port's documentation and how to correctly write and fix documentation content.
4-
5-
## How to contribute
6-
7-
The best way to suggest edits for an existing page is by using the "Edit this page" button at the bottom of most docs, this button will take you to the GitHub interface to make and propose changes.
8-
9-
If you want to add a new documentation page, please fork the repository and after adding the new docs, create a PR which will be reviewed by our team.
10-
11-
Contributions are very welcome. If you need help planning your contribution, feel free to ask us by opening an issue in this repository or by writing in our [community Slack](https://join.slack.com/t/getport/shared_invite/zt-1v5z1z1v-3~1Q1Q1).
3+
This document details guidelines for contributing to Port's documentation, and demonstrates how to correctly write and review documentation content.
124

135
## Styling guidelines
146

0 commit comments

Comments
 (0)