mirror of
https://gitea.com/gitea/docs.git
synced 2026-07-02 08:58:45 +00:00
Upgrade docusarus and fix broken links (#301)
Reviewed-on: https://gitea.com/gitea/docs/pulls/301
This commit is contained in:
@@ -9,7 +9,7 @@ aliases:
|
||||
# Customizing Gitea
|
||||
|
||||
Customizing Gitea is typically done using the `CustomPath` folder - by default this is
|
||||
the `custom` folder from the working directory (WorkPath), but may be different if your [installation](../installation/installation.md) has
|
||||
the `custom` folder from the working directory (WorkPath), but may be different if your [installation](../installation/from-binary.md) has
|
||||
set this differently. This is the central place to override configuration settings,
|
||||
templates, etc. You can check the `CustomPath` using `gitea help`. You can also find
|
||||
the path on the _Configuration_ tab in the _Site Administration_ page. You can override
|
||||
@@ -23,7 +23,7 @@ the Linux Filesystem Standard. Gitea will attempt to create required folders, in
|
||||
`custom/`. Distributions may provide a symlink for `custom` using `/etc/gitea/`.
|
||||
|
||||
Application settings can be found in file `CustomConf` which is by default,
|
||||
`$GITEA_CUSTOM/conf/app.ini` but may be different if your [installation](../installation/installation.md) has set this differently.
|
||||
`$GITEA_CUSTOM/conf/app.ini` but may be different if your [installation](../installation/from-binary.md) has set this differently.
|
||||
Again `gitea help` will allow you review this variable and you can override it using the
|
||||
`--config` option on the `gitea` binary.
|
||||
|
||||
@@ -414,7 +414,7 @@ The [legacy file format](https://github.com/go-gitea/gitea/blob/main/options/lab
|
||||
|
||||
`#hex-color label name ; label description`
|
||||
|
||||
For more information, see the [labels documentation](usage/labels.md).
|
||||
For more information, see the [labels documentation](../usage/issues-prs/labels.md).
|
||||
|
||||
### Licenses
|
||||
|
||||
|
||||
76
docs/contributing/contributing.md
Normal file
76
docs/contributing/contributing.md
Normal file
@@ -0,0 +1,76 @@
|
||||
---
|
||||
slug: "contributing"
|
||||
sidebar_position: 1
|
||||
---
|
||||
|
||||
# Contributing to Gitea
|
||||
|
||||
Thank you for your interest in contributing to Gitea! This guide will help you understand how to contribute to the project effectively.
|
||||
|
||||
## Getting Started
|
||||
|
||||
Before you start contributing, please read our [Hacking on Gitea](../development/hacking-on-gitea.md) guide to set up your development environment.
|
||||
|
||||
## Contribution Guidelines
|
||||
|
||||
We have specific guidelines for different types of contributions:
|
||||
|
||||
### Backend Development
|
||||
|
||||
If you're working on backend code (Go), please follow our [Guidelines for Backend Development](guidelines-backend.md). This includes:
|
||||
|
||||
- Package design and dependencies
|
||||
- Database operations and migrations
|
||||
- Testing strategies
|
||||
- Code organization
|
||||
|
||||
### Frontend Development
|
||||
|
||||
For frontend contributions (JavaScript, CSS, Vue), refer to our [Guidelines for Frontend Development](guidelines-frontend.md). This covers:
|
||||
|
||||
- Framework usage (Vue3, Fomantic-UI)
|
||||
- Code style and best practices
|
||||
- Accessibility requirements
|
||||
- TypeScript usage
|
||||
|
||||
### Refactoring
|
||||
|
||||
When refactoring existing code, follow our [Guidelines for Refactoring](guidelines-refactoring.md) to ensure:
|
||||
|
||||
- Clear refactoring objectives
|
||||
- Proper review process
|
||||
- Maintaining backward compatibility
|
||||
- Incremental improvements
|
||||
|
||||
### Localization
|
||||
|
||||
To contribute translations or localization improvements, see our [Localization Guide](localization.md) which explains:
|
||||
|
||||
- How to contribute translations via Crowdin
|
||||
- Supported languages
|
||||
- Translation workflow
|
||||
|
||||
## Code of Conduct
|
||||
|
||||
Please be respectful and constructive in all interactions with the community. We are committed to providing a welcoming and inclusive environment for all contributors.
|
||||
|
||||
## Getting Help
|
||||
|
||||
If you need help with your contribution:
|
||||
|
||||
- Join our [Discord](https://discord.gg/gitea) #Develop channel
|
||||
- Visit our [Forum](https://forum.gitea.com/)
|
||||
- Check existing [GitHub Issues](https://github.com/go-gitea/gitea/issues)
|
||||
|
||||
## Submitting Your Contribution
|
||||
|
||||
1. Fork the repository
|
||||
2. Create a feature branch
|
||||
3. Make your changes following the relevant guidelines
|
||||
4. Write tests for your changes
|
||||
5. Ensure all tests pass
|
||||
6. Submit a pull request
|
||||
|
||||
For more details, see our [CONTRIBUTING.md](https://github.com/go-gitea/gitea/blob/main/CONTRIBUTING.md) in the main repository.
|
||||
|
||||
Thank you for helping make Gitea better!
|
||||
@@ -174,7 +174,7 @@ server as mentioned above.
|
||||
|
||||
### Working on JS and CSS
|
||||
|
||||
Frontend development should follow [Guidelines for Frontend Development](contributing/guidelines-frontend.md)
|
||||
Frontend development should follow [Guidelines for Frontend Development](../contributing/guidelines-frontend.md)
|
||||
|
||||
To build with frontend resources, either use the `watch-frontend` target mentioned above or just build once:
|
||||
|
||||
|
||||
@@ -76,7 +76,7 @@ And you can see the new runner in the management page:
|
||||
|
||||

|
||||
|
||||
You can find more information by visiting [Act runner](usage/actions/act-runner.md).
|
||||
You can find more information by visiting [Act runner](act-runner.mdxc).
|
||||
|
||||
### Use Actions
|
||||
|
||||
|
||||
@@ -18,7 +18,7 @@ For organizations, you can define organization-wide labels that are shared with
|
||||
|
||||
Labels have a mandatory name, a mandatory color, an optional description, and must either be exclusive or not (see `Scoped Labels` below).
|
||||
|
||||
When you create a repository, you can ensure certain labels exist by using the `Issue Labels` option. This option lists a number of available label sets that are [configured globally on your instance](../administration/customizing-gitea.md#labels). Its contained labels will all be created as well while creating the repository.
|
||||
When you create a repository, you can ensure certain labels exist by using the `Issue Labels` option. This option lists a number of available label sets that are [configured globally on your instance](../../administration/customizing-gitea.md#labels). Its contained labels will all be created as well while creating the repository.
|
||||
|
||||
## Scoped Labels
|
||||
|
||||
|
||||
@@ -85,7 +85,7 @@ Sometimes a commit or pull request may fix or bring back a problem documented
|
||||
in a particular issue. Gitea supports closing and reopening the referenced
|
||||
issues by preceding the reference with a particular _keyword_. Common keywords
|
||||
include "closes", "fixes", "reopens", etc. This list can be
|
||||
[customized](../administration/config-cheat-sheet.md) by the
|
||||
[customized](../../administration/config-cheat-sheet.md) by the
|
||||
site administrator.
|
||||
|
||||
Example:
|
||||
|
||||
@@ -57,4 +57,4 @@ The first value of the list will be used in helpers.
|
||||
|
||||
## Pull Request Templates
|
||||
|
||||
You can find more information about pull request templates at the page [Issue and Pull Request templates](usage/issue-pull-request-templates.md).
|
||||
You can find more information about pull request templates at the page [Issue and Pull Request templates](issue-pull-request-templates.md).
|
||||
|
||||
Reference in New Issue
Block a user