Format README (#408)
Some small formatting changes which are auto-applied by the markdown code styler in vscode (which I am using a lot). These are also present in #407. Merging this before/in general would help be a bit when tinkering with the README. Mainly indentation related, plus some single quotes -> double quotes changes. Co-authored-by: pat-s <patrick.schratz@gmail.com> Reviewed-on: https://gitea.com/gitea/helm-chart/pulls/408 Reviewed-by: Lunny Xiao <xiaolunwen@gmail.com> Reviewed-by: techknowlogick <techknowlogick@noreply.gitea.io> Co-authored-by: pat-s <pat-s@noreply.gitea.io> Co-committed-by: pat-s <pat-s@noreply.gitea.io>
This commit is contained in:
parent
18100cca11
commit
c46bf7c60f
12
.editorconfig
Normal file
12
.editorconfig
Normal file
@ -0,0 +1,12 @@
|
|||||||
|
# EditorConfig is awesome: https://EditorConfig.org
|
||||||
|
|
||||||
|
# top-most EditorConfig file
|
||||||
|
root = true
|
||||||
|
|
||||||
|
[*]
|
||||||
|
indent_style = space
|
||||||
|
indent_size = 2
|
||||||
|
end_of_line = lf
|
||||||
|
charset = utf-8
|
||||||
|
trim_trailing_whitespace = false
|
||||||
|
insert_final_newline = false
|
@ -14,6 +14,7 @@ When using Visual Studio Code as IDE, following plugins might be useful:
|
|||||||
- [Markdown All in One](https://marketplace.visualstudio.com/items?itemName=yzhang.markdown-all-in-one)
|
- [Markdown All in One](https://marketplace.visualstudio.com/items?itemName=yzhang.markdown-all-in-one)
|
||||||
- [markdownlint](https://marketplace.visualstudio.com/items?itemName=DavidAnson.vscode-markdownlint)
|
- [markdownlint](https://marketplace.visualstudio.com/items?itemName=DavidAnson.vscode-markdownlint)
|
||||||
- [Helm Intellisense](https://marketplace.visualstudio.com/items?itemName=Tim-Koehler.helm-intellisense)
|
- [Helm Intellisense](https://marketplace.visualstudio.com/items?itemName=Tim-Koehler.helm-intellisense)
|
||||||
|
- [Prettier - Code formatter](https://marketplace.visualstudio.com/items?itemName=esbenp.prettier-vscode)
|
||||||
|
|
||||||
## Documentation Requirements
|
## Documentation Requirements
|
||||||
|
|
||||||
|
20
README.md
20
README.md
@ -125,7 +125,7 @@ ENABLED = false
|
|||||||
### Additional _app.ini_ settings
|
### Additional _app.ini_ settings
|
||||||
|
|
||||||
> **The [generic](https://docs.gitea.io/en-us/config-cheat-sheet/#overall-default)
|
> **The [generic](https://docs.gitea.io/en-us/config-cheat-sheet/#overall-default)
|
||||||
section cannot be defined that way.**
|
> section cannot be defined that way.**
|
||||||
|
|
||||||
Some settings inside _app.ini_ (like passwords or whole authentication configurations)
|
Some settings inside _app.ini_ (like passwords or whole authentication configurations)
|
||||||
must be considered sensitive and therefore should not be passed via plain text
|
must be considered sensitive and therefore should not be passed via plain text
|
||||||
@ -474,11 +474,11 @@ Multiple OAuth2 sources can be configured with additional OAuth list items.
|
|||||||
```yaml
|
```yaml
|
||||||
gitea:
|
gitea:
|
||||||
oauth:
|
oauth:
|
||||||
- name: 'MyAwesomeGiteaOAuth'
|
- name: "MyAwesomeGiteaOAuth"
|
||||||
provider: 'openidConnect'
|
provider: "openidConnect"
|
||||||
key: 'hello'
|
key: "hello"
|
||||||
secret: 'world'
|
secret: "world"
|
||||||
autoDiscoverUrl: 'https://gitea.example.com/.well-known/openid-configuration'
|
autoDiscoverUrl: "https://gitea.example.com/.well-known/openid-configuration"
|
||||||
#useCustomUrls:
|
#useCustomUrls:
|
||||||
#customAuthUrl:
|
#customAuthUrl:
|
||||||
#customTokenUrl:
|
#customTokenUrl:
|
||||||
@ -502,7 +502,7 @@ stringData:
|
|||||||
```yaml
|
```yaml
|
||||||
gitea:
|
gitea:
|
||||||
oauth:
|
oauth:
|
||||||
- name: 'MyAwesomeGiteaOAuth'
|
- name: "MyAwesomeGiteaOAuth"
|
||||||
existingSecret: gitea-oauth-secret
|
existingSecret: gitea-oauth-secret
|
||||||
...
|
...
|
||||||
```
|
```
|
||||||
@ -893,9 +893,9 @@ automatically in certain situations:
|
|||||||
configuration nor via auto generation. We explicitly prevent to set new secrets.
|
configuration nor via auto generation. We explicitly prevent to set new secrets.
|
||||||
|
|
||||||
> 💡 It would be possible to set new secret keys manually by entering
|
> 💡 It would be possible to set new secret keys manually by entering
|
||||||
the running container and rewriting the app.ini by hand. However, this it is
|
> the running container and rewriting the app.ini by hand. However, this it is
|
||||||
not advisable to do so for existing installations. Certain settings like
|
> not advisable to do so for existing installations. Certain settings like
|
||||||
_LDAP_ would not be readable anymore.
|
> _LDAP_ would not be readable anymore.
|
||||||
|
|
||||||
#### Probes
|
#### Probes
|
||||||
|
|
||||||
|
Loading…
x
Reference in New Issue
Block a user