37 lines
2.4 KiB
Markdown
37 lines
2.4 KiB
Markdown
# Contributing to Appsmith Documentation
|
|
|
|
Thank you for your interest in Appsmith and taking the time out to contribute to our documentation. 🙌
|
|
Feel free to propose changes to this document in a pull request.
|
|
|
|
Appsmith uses Gitbook for [documentation](https://docs.appsmith.com). The docs are backed by the [appsmith-docs](https://github.com/appsmithorg/appsmith-docs) repository
|
|
|
|
## Suggesting Improvements
|
|
|
|
If you feel parts of our documentation can be improved or have incorrect information, you can open a new issue using our [Documentation Template](https://github.com/appsmithorg/appsmith/issues/new?assignees=Nikhil-Nandagopal&labels=Documentation&template=---documentation-improvement.md&title=%5BDocs%5D+)
|
|
|
|
## Contributing
|
|
|
|
Our [good first issues](https://github.com/appsmithorg/appsmith/issues?q=is%3Aissue+is%3Aopen+label%3A%22Good+First+Issue%22+label%3A%22Documentation%22+no%3Aassignee) or [Documentation issues](https://github.com/appsmithorg/appsmith-docs/issues) list is the best place to begin contributing
|
|
|
|
### Updating the docs
|
|
|
|
Before raising a pull request, ensure you have raised a corresponding issue and discussed it with a maintainer. This gives your pull request the highest chance of getting merged quickly.
|
|
|
|
1. Fork the [appsmith-docs](https://github.com/appsmithorg/appsmith-docs) repo and branch out from the default branch.
|
|
2. If a new release is being created, contact a maintainer to update the default branch to mirror the new release version.
|
|
3. Read our [guidelines](#guidelines) for the section you wish to update
|
|
4. Add / Update the relevant files and commit them with a clear commit message
|
|
5. If you are creating a new page, don't forget to add an entry in the SUMMARY.md file of the main repo
|
|
6. Create a pull request in your fork to the default branch in the appsmithorg/appsmith-docs base repository
|
|
7. Link the issue of the base repository in your Pull request description. [Guide](https://docs.github.com/en/free-pro-team@latest/github/managing-your-work-on-github/linking-a-pull-request-to-an-issue)
|
|
|
|
## Guidelines
|
|
|
|
To maintain consistency, we have a set structure for the different types of documentation pages on appsmith. Refer to the following when updating the docs
|
|
|
|
- [Documenting Widgets](Widgets.md)
|
|
- [Documenting Functions](InternalFunctions.md)
|
|
- [Documenting DB Integrations](DB%20Integrations.md)
|
|
- [Adding Guides](adding_guides.md)
|
|
- [Uploading Assets](UploadingAssets.md)
|