docs: Updating contribution guidelines (#18190)
The contribution guidelines for documentation are outdated due to the recent migration. Here are the fixes/updates - - Removed the following files from `contribution/docs/` - - [CONTRIBUTING.md](https://github.com/appsmithorg/appsmith/blob/release/contributions/docs/CONTRIBUTING.md) - [DB Integrations.md](https://github.com/appsmithorg/appsmith/blob/release/contributions/docs/DB%20Integrations.md) - [UploadingAssets.md](https://github.com/appsmithorg/appsmith/blob/release/contributions/docs/UploadingAssets.md) - [Widgets.md](https://github.com/appsmithorg/appsmith/blob/release/contributions/docs/Widgets.md) - [adding_guides.md](https://github.com/appsmithorg/appsmith/blob/release/contributions/docs/adding_guides.md) - Removed [Documentation Improvement](https://github.com/appsmithorg/appsmith/blob/release/.github/ISSUE_TEMPLATE/--documentation-improvement.yaml) template as we have created [new templates](https://github.com/appsmithorg/appsmith-docs/issues/new/choose) in the [appsmith-docs](https://github.com/appsmithorg/appsmith-docs) repository. - Updated the relevant links in the [Documentation Improvement](https://github.com/appsmithorg/appsmith/blob/release/CONTRIBUTING.md#-improve-the-documentation) section ( template links and contribution guidelines for docs) of [CONTRIBUTING.md](https://github.com/appsmithorg/appsmith/blob/release/CONTRIBUTING.md) file. Co-authored-by: Pranay105 <pranaybhardwaj@Pranays-MacBook-Pro.local>
This commit is contained in:
Pranay
GitHub
parent
224353743d
commit
b7b024a98c
|
|
@ -1,37 +0,0 @@
|
|||
name: 📖 Documentation Improvement
|
||||
description: Suggest improvements to our documentation
|
||||
title: "[Docs]: "
|
||||
labels: [Documentation]
|
||||
assignees:
|
||||
- Nikhil-Nandagopal
|
||||
- danciaclara
|
||||
body:
|
||||
- type: markdown
|
||||
attributes:
|
||||
value: |
|
||||
Thanks for taking the time to fill out this documentation improvement request!
|
||||
- type: checkboxes
|
||||
attributes:
|
||||
label: Is there an existing issue for this?
|
||||
description: Please search to see if an issue realated to this already exists.
|
||||
options:
|
||||
- label: I have searched the existing issues
|
||||
required: true
|
||||
- type: input
|
||||
attributes:
|
||||
label: Documentation Link
|
||||
description: Add a link to the page which needs improvement (if relevant)
|
||||
validations:
|
||||
required: false
|
||||
- type: textarea
|
||||
attributes:
|
||||
label: Describe the problem
|
||||
description: Is the documentation missing? Or is it confusing? Why is it confusing?
|
||||
validations:
|
||||
required: true
|
||||
- type: textarea
|
||||
attributes:
|
||||
label: Describe the improvement
|
||||
description: A clear and concise description of the improvement.
|
||||
validations:
|
||||
required: true
|
||||
|
|
@ -21,7 +21,7 @@ We welcome all feature requests, whether it's to add new functionality to an exi
|
|||
File your feature request through GitHub Issues using the [Feature Request](https://github.com/appsmithorg/appsmith/issues/new?assignees=Nikhil-Nandagopal&labels=Enhancement&template=--feature-request.yaml&title=%5BFeature%5D%3A+) template.
|
||||
|
||||
#### 📝 Improve the documentation
|
||||
In the process of shipping features quickly, we may forget to keep our docs up to date. You can help by suggesting improvements to our documentation using the [Documentation Improvement](https://github.com/appsmithorg/appsmith/issues/new?assignees=Nikhil-Nandagopal&labels=Documentation&template=--documentation-improvement.yaml&title=%5BDocs%5D%3A+) template or dive right into our [Docs Contribution Guide](contributions/docs/CONTRIBUTING.md)!
|
||||
In the process of shipping features quickly, we may forget to keep our docs up to date. You can help by suggesting improvements to our documentation using the [Documentation templates](https://github.com/appsmithorg/appsmith-docs/issues/new/choose) or dive right into our [Docs Contribution Guide](https://github.com/appsmithorg/appsmith-docs/blob/main/CONTRIBUTING.md)!
|
||||
|
||||
#### ⚙️ Close a Bug / Feature issue
|
||||
We welcome contributions that help make appsmith bug free & improve the experience of our users. You can also find issues tagged [Good First Issues](https://github.com/appsmithorg/appsmith/issues?q=is%3Aopen+is%3Aissue+label%3A%22Good+First+Issue%22+bug). Check out our [Code Contribution Guide](contributions/CodeContributionsGuidelines.md) to begin.
|
||||
|
|
|
|||
|
|
@ -1,36 +0,0 @@
|
|||
# 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)
|
||||
|
|
@ -1,21 +0,0 @@
|
|||
# DB Integration
|
||||
Create a appsmith-docs/datasource-reference/<integratiom>.md file.
|
||||
Follow the [asset-upload](./UploadingAssets.md) guidelines to upload and use an asset in docs.
|
||||
Update the SUMMARY.md file with the link to the new document
|
||||
|
||||
## Action docs template
|
||||
Copy paste this template
|
||||
```
|
||||
---
|
||||
description: >-
|
||||
Integration Description
|
||||
---
|
||||
|
||||
# Connection Settings
|
||||
|
||||
# Querying the database
|
||||
|
||||
# Using Queries in applications
|
||||
|
||||
```
|
||||
|
||||
|
|
@ -1,6 +1,6 @@
|
|||
# How can I contribute to the Cypress Test Suite?
|
||||
|
||||
1. Follow the setup document to set up [Appsmith locally](contributions/ClientSetup.md) and go through [the docs](https://docs.appsmith.com). The docs are backed by the [appsmith-docs](https://github.com/appsmithorg/appsmith-docs) repository.
|
||||
1. Follow the setup document to set up [Appsmith locally](/contributions/ClientSetup.md) and go through [the docs](https://docs.appsmith.com). The docs are backed by the [appsmith-docs](https://github.com/appsmithorg/appsmith-docs) repository.
|
||||
|
||||
1. Once we have the setup in place, all dependencies will be available locally for test execution.
|
||||
|
||||
|
|
|
|||
|
|
@ -1,20 +0,0 @@
|
|||
# Uploading and using assets
|
||||
Upload images & gifs to the `appsmith-docs/.gitbook/assets/` folder.
|
||||
Asset files cannot be larger than 25mb.
|
||||
Refer to the assets using a relative path from the root folder Ex. `.gitbook/assets/asset.jpg`
|
||||
|
||||
## Embedding Images & Gifs
|
||||
Images are gifs can be embedded into a page using the following syntax
|
||||
```
|
||||
|
||||
```
|
||||
The images should be focused on the content and not include unnecessary parts of the UI ex. header / empty canvas etc.
|
||||
Gifs can be recorded using the a screen recorder like loom and converted to a gif using gifski. Gifs should be of 26 - 30 fps and be of high quality. If you do not have access to a good gif converter, please upload the video as is and raise a PR. We will be happy to help with Gif creation!
|
||||
|
||||
## Embedding Videos
|
||||
Videos must be uploaded to the appsmith youtube channel. Contact nikhil@appsmith.com to have your video uploaded.
|
||||
Videos must be of very high quality and abide by our [Code of Conduct](/CODE_OF_CONDUCT.md)
|
||||
Videos can be embedded inside pages using the following syntax
|
||||
```
|
||||
{% embed url="https://www.youtube.com/watch?v=mzqK0QIZRLs&feature=youtu.be" %}
|
||||
```
|
||||
|
|
@ -1,30 +0,0 @@
|
|||
# Widget docs
|
||||
1. Create a appsmith-docs/widget-reference/<widget>.md file.
|
||||
2. Follow the [asset-upload](UploadingAssets.md) guidelines to upload and use an asset in the docs.
|
||||
|
||||
## Widget docs template
|
||||
Copy paste this template
|
||||
```
|
||||
|
||||
# WidgetName
|
||||
|
||||
<Add a description here>
|
||||
|
||||
## Image/gif of the widget on the canvas with the icon of the widget in the sidebar
|
||||
|
||||
## 2 different usages of the widget with API / Query data
|
||||
|
||||
## Properties
|
||||
| Property | Description |
|
||||
| :------------ | :-------------------- |
|
||||
| **property1** | Property1 description |
|
||||
| **property2** | Property2 description |
|
||||
| **property3** | Property3 description |
|
||||
|
||||
| Action | Description |
|
||||
| :---------- | :------------------ |
|
||||
| **action1** | action1 description |
|
||||
| **action2** | action2 description |
|
||||
| **action3** | action3 description |
|
||||
```
|
||||
|
||||
|
|
@ -1,20 +0,0 @@
|
|||
## Adding a Guide
|
||||
|
||||
1. Create an **appsmith-docs/how-to-guide/.md** file. Please Use valid markdown for all the content.
|
||||
2. Follow the [asset-upload](https://github.com/appsmithorg/appsmith/blob/release/contributions/docs/UploadingAssets.md) guidelines to upload and use an asset in the docs.
|
||||
|
||||
## Guide Template
|
||||
|
||||
Start your guide using this template. Paste this template at the beginning of your document.
|
||||
|
||||
```
|
||||
---
|
||||
description: >-
|
||||
<<Introduction to the topic>>
|
||||
---
|
||||
|
||||
# Name of the topic
|
||||
|
||||
```
|
||||
|
||||
Refer to this [Guide](https://github.com/appsmithorg/appsmith-docs/blob/v1.3/how-to-guides/embed-appsmith-into-existing-application.md) as an example.
|
||||
Loading…
Reference in New Issue
Block a user