PromucFlow_constructor/contributions/docs/CONTRIBUTING.md

37 lines
2.4 KiB
Markdown
Raw Normal View History

Release (#850) * Stop showing empty table when there are no records (#790) * Datasource explorer fixes (#789) - Expand datasource by default - Let column/key name take more space. - Show column popup on hover instead of click * Show datasources without grouping by plugins in explorer (#660) * Immutable Widgets (#799) Co-authored-by: Abhinav Jha <abhinav@appsmith.com> * Removing the docker login step that causes forked PRs to fail (#844) Also adding pull_request_target event for release and master branch. This will run the GH Actions in the context of the base repository instead of the forked one. Hence, the secrets for Cypress, Docker etc can be passed down to the action for PRs being raised via a fork * Datasource structure support for MongoDB (#641) * Added structure for MongoDB datasources * Fixed tests for MongoDB template queries * Updating readme to test forked PRs (#845) * Adding additional docs contribution files. (#849) * Update CONTRIBUTING.md * Rename action.md to ActionsGuide.md * Rename asset-upload.md to UploadingAssets.md * Rename db-integration.md to DB Integrations.md * Rename widget.md to Widgets.md * Rename ActionsGuide.md to Actions.md * Create CONTRIBUTING.md * Update Actions.md * Update Actions.md * Update Widgets.md * Update UploadingAssets.md * Update CONTRIBUTING.md * Update CONTRIBUTING.md * Update CONTRIBUTING.md * Update CONTRIBUTING.md Co-authored-by: akash-codemonk <67054171+akash-codemonk@users.noreply.github.com> Co-authored-by: Hetu Nandu <hetunandu@gmail.com> Co-authored-by: Abhinav Jha <abhinav@appsmith.com> Co-authored-by: Arpit Mohan <mohanarpit@users.noreply.github.com> Co-authored-by: Shrikant Sharat Kandula <shrikant@appsmith.com> Co-authored-by: satbir121 <39981226+satbir121@users.noreply.github.com>
2020-10-01 10:18:50 +00:00
# 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
Release (#850) * Stop showing empty table when there are no records (#790) * Datasource explorer fixes (#789) - Expand datasource by default - Let column/key name take more space. - Show column popup on hover instead of click * Show datasources without grouping by plugins in explorer (#660) * Immutable Widgets (#799) Co-authored-by: Abhinav Jha <abhinav@appsmith.com> * Removing the docker login step that causes forked PRs to fail (#844) Also adding pull_request_target event for release and master branch. This will run the GH Actions in the context of the base repository instead of the forked one. Hence, the secrets for Cypress, Docker etc can be passed down to the action for PRs being raised via a fork * Datasource structure support for MongoDB (#641) * Added structure for MongoDB datasources * Fixed tests for MongoDB template queries * Updating readme to test forked PRs (#845) * Adding additional docs contribution files. (#849) * Update CONTRIBUTING.md * Rename action.md to ActionsGuide.md * Rename asset-upload.md to UploadingAssets.md * Rename db-integration.md to DB Integrations.md * Rename widget.md to Widgets.md * Rename ActionsGuide.md to Actions.md * Create CONTRIBUTING.md * Update Actions.md * Update Actions.md * Update Widgets.md * Update UploadingAssets.md * Update CONTRIBUTING.md * Update CONTRIBUTING.md * Update CONTRIBUTING.md * Update CONTRIBUTING.md Co-authored-by: akash-codemonk <67054171+akash-codemonk@users.noreply.github.com> Co-authored-by: Hetu Nandu <hetunandu@gmail.com> Co-authored-by: Abhinav Jha <abhinav@appsmith.com> Co-authored-by: Arpit Mohan <mohanarpit@users.noreply.github.com> Co-authored-by: Shrikant Sharat Kandula <shrikant@appsmith.com> Co-authored-by: satbir121 <39981226+satbir121@users.noreply.github.com>
2020-10-01 10:18:50 +00:00
### 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
2020-10-02 09:23:20 +00:00
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)
Release (#850) * Stop showing empty table when there are no records (#790) * Datasource explorer fixes (#789) - Expand datasource by default - Let column/key name take more space. - Show column popup on hover instead of click * Show datasources without grouping by plugins in explorer (#660) * Immutable Widgets (#799) Co-authored-by: Abhinav Jha <abhinav@appsmith.com> * Removing the docker login step that causes forked PRs to fail (#844) Also adding pull_request_target event for release and master branch. This will run the GH Actions in the context of the base repository instead of the forked one. Hence, the secrets for Cypress, Docker etc can be passed down to the action for PRs being raised via a fork * Datasource structure support for MongoDB (#641) * Added structure for MongoDB datasources * Fixed tests for MongoDB template queries * Updating readme to test forked PRs (#845) * Adding additional docs contribution files. (#849) * Update CONTRIBUTING.md * Rename action.md to ActionsGuide.md * Rename asset-upload.md to UploadingAssets.md * Rename db-integration.md to DB Integrations.md * Rename widget.md to Widgets.md * Rename ActionsGuide.md to Actions.md * Create CONTRIBUTING.md * Update Actions.md * Update Actions.md * Update Widgets.md * Update UploadingAssets.md * Update CONTRIBUTING.md * Update CONTRIBUTING.md * Update CONTRIBUTING.md * Update CONTRIBUTING.md Co-authored-by: akash-codemonk <67054171+akash-codemonk@users.noreply.github.com> Co-authored-by: Hetu Nandu <hetunandu@gmail.com> Co-authored-by: Abhinav Jha <abhinav@appsmith.com> Co-authored-by: Arpit Mohan <mohanarpit@users.noreply.github.com> Co-authored-by: Shrikant Sharat Kandula <shrikant@appsmith.com> Co-authored-by: satbir121 <39981226+satbir121@users.noreply.github.com>
2020-10-01 10:18:50 +00:00
## 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
2020-10-01 10:19:58 +00:00
- [Documenting Widgets](Widgets.md)
2020-10-01 10:56:27 +00:00
- [Documenting Functions](InternalFunctions.md)
2020-10-01 10:19:58 +00:00
- [Documenting DB Integrations](DB%20Integrations.md)
- [Adding Guides](adding_guides.md)
2020-10-01 10:19:58 +00:00
- [Uploading Assets](UploadingAssets.md)