h759bkyo4/Documentation
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity

make the warning about secrest more visible

Browse source
This commit is contained in:
René Wagner 2021-06-20 09:27:05 +02:00
parent 837a168192
commit 75c9cd1d13
No known key found for this signature in database
GPG key ID: 2B8BCD69606E7F19
1 changed files with 5 additions and 3 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

8
content/getting-started/wiki.md
View file

@ -14,12 +14,15 @@ The user in these examples is *knut* the polar bear and its repository is *fooba
## Activation and Permissions
To enable the Wiki for a project, visit the `Settings` page and activate `Enable Repository Wiki` in the `Advanced Section`. It will default to the build-in wiki which is described here, but you can as well add an URI to an external site the "Wiki" tab should link to (not part of this doc).
Be aware that the wiki, once enabled, is accessible for *everyone* who has `read` access your project - on public projects even unauthorized guests can access the wiki. It is **not** suitable for storing secrets (like passwords and so on).
Be aware that the wiki, once enabled, is accessible for *everyone* who has `read` access your project - on public projects even unauthorized guests can access the wiki.
> **Warning**
> The wiki is *not* a suitable place for storing private information or secrets (like passwords).
To edit the Wiki `write` permission to the project is required.
## Wiki structure
The Wiki is essentially a separate Git repo in your project with a predefined name like `<your-projects-name>.wiki.git`.
The Wiki is essentially a separate Git repo in your project with a predefined name in the form of `<your-projects-name>.wiki.git`.
It consists of [Markdown](https://en.wikipedia.org/wiki/Markdown) files (file extension `.md`) and additional assets like images.
No further style sheets are needed. The markdown files are automatically rendered according to the selected Codeberg theme.
@ -33,7 +36,6 @@ Using the web UI in your browser is currently limited to add/update/delete pages
<img src="/assets/images/getting-started/wiki/wiki_pageview.png" alt="Wiki home page with edit buttons">
</picture>
## Adding content via a local git client
You can work with the Wiki repo as with any other Git repo on Codeberg, see our docs about managing a Git repo [via CLI](https://docs.codeberg.org/git/clone-commit-via-cli).