mirror of
				https://github.com/go-gitea/gitea
				synced 2025-10-31 19:38:23 +00:00 
			
		
		
		
	Have new announcement about docs contributions (#31364)
According to the maintainers' discussion and voting. We decide to move docs to https://gitea.com/gitea/docs . Add some hints on this repository to not make contributors confusing.
This commit is contained in:
		
							
								
								
									
										11
									
								
								.github/pull_request_template.md
									
									
									
									
										vendored
									
									
								
							
							
						
						
									
										11
									
								
								.github/pull_request_template.md
									
									
									
									
										vendored
									
									
								
							| @@ -1,9 +1,10 @@ | |||||||
| <!-- start tips -->  | <!-- start tips --> | ||||||
| Please check the following: | Please check the following: | ||||||
| 1. Make sure you are targeting the `main` branch, pull requests on release branches are only allowed for backports. | 1. Make sure you are targeting the `main` branch, pull requests on release branches are only allowed for backports. | ||||||
| 2. Make sure you have read contributing guidelines: https://github.com/go-gitea/gitea/blob/main/CONTRIBUTING.md . | 2. Make sure you have read contributing guidelines: https://github.com/go-gitea/gitea/blob/main/CONTRIBUTING.md . | ||||||
| 3. Describe what your pull request does and which issue you're targeting (if any). | 3. For documentations contribution, please go to https://gitea.com/gitea/docs | ||||||
| 4. It is recommended to enable "Allow edits by maintainers", so maintainers can help more easily. | 4. Describe what your pull request does and which issue you're targeting (if any). | ||||||
| 5. Your input here will be included in the commit message when this PR has been merged. If you don't want some content to be included, please separate them with a line like `---`. | 5. It is recommended to enable "Allow edits by maintainers", so maintainers can help more easily. | ||||||
| 6. Delete all these tips before posting. | 6. Your input here will be included in the commit message when this PR has been merged. If you don't want some content to be included, please separate them with a line like `---`. | ||||||
|  | 7. Delete all these tips before posting. | ||||||
| <!-- end tips --> | <!-- end tips --> | ||||||
|   | |||||||
| @@ -358,7 +358,8 @@ $REWRITTEN_PR_SUMMARY | |||||||
|  |  | ||||||
| ## Documentation | ## Documentation | ||||||
|  |  | ||||||
| If you add a new feature or change an existing aspect of Gitea, the documentation for that feature must be created or updated in the same PR. | If you add a new feature or change an existing aspect of Gitea, the documentation for that feature must be created or updated in another PR at [https://gitea.com/gitea/docs](https://gitea.com/gitea/docs). | ||||||
|  | **The docs directory on main repository will be removed at some time. We will have a yaml file to store configuration file's meta data. After that completed, configuration documentation should be in the main repository.** | ||||||
|  |  | ||||||
| ## API v1 | ## API v1 | ||||||
|  |  | ||||||
|   | |||||||
		Reference in New Issue
	
	Block a user