chenyue/docs
1
0
Fork 0
Code Issues Pull Requests Actions 3 Packages Projects Releases Wiki Activity
2,085 Commits 4 Branches 5 Tags
53596559bee6f606be966afef4f0ad66266685e5
Commit Graph
46 Commits
This Branch
This Branch
All Branches
Author SHA1 Message Date
jolheiserandJohn Olheiser a6008e65af fix: correct url for awesome-gitea "edit this page" (#109) 
Signed-off-by: jolheiser <john.olheiser@gmail.com>
Reviewed-on: https://gitea.com/gitea/gitea-docusaurus/pulls/109
Reviewed-by: Lunny Xiao <xiaolunwen@gmail.com>
Co-authored-by: jolheiser <john.olheiser@gmail.com>
Co-committed-by: jolheiser <john.olheiser@gmail.com>
 2024-02-19 16:13:00 +00:00
John OlheiserandGitHub 6d8e32689d Update docs for docusaurus v3 (#28125) 
Updates the docs for usage with docusaurus v3

Signed-off-by: jolheiser <john.olheiser@gmail.com>
 2023-11-20 00:25:47 -05:00
John OlheiserandGitHub 79dfabcd5a Update docs for docusaurus v3 (#28128) 
Signed-off-by: jolheiser <john.olheiser@gmail.com>
 2023-11-20 00:25:22 -05:00
John OlheiserandGitHub 163765d335 Update docs for docusaurus v3 (#28126) 
Signed-off-by: jolheiser <john.olheiser@gmail.com>
 2023-11-20 00:24:50 -05:00
John OlheiserandGitHub 82ce3ded0a Update docs for docusaurus v3 (#28127) 
Signed-off-by: jolheiser <john.olheiser@gmail.com>
 2023-11-20 00:24:36 -05:00
jolheiserandtechknowlogick 52841fa1d9 Makefile enhancements (#89) 
These are some things I changed to make local development easier, especially when having to update multiple versions of docs at once like the docusaurus v3 update.

i.e.
```makefile
GITEA_REMOTE := ~/code/code.gitea.io/gitea
GITEA_LATEST_BRANCH := docs-v3
GITEA_VERSION_BRANCH_PREFIX := docs-v3-
...
```
to run the Makefile against my local repo.

Reviewed-on: https://gitea.com/gitea/gitea-docusaurus/pulls/89
Co-authored-by: jolheiser <john.olheiser@gmail.com>
Co-committed-by: jolheiser <john.olheiser@gmail.com>
 2023-11-20 04:27:27 +00:00
jolheiserandLunny Xiao ca34387b0c feat: plausible (#66) 
Adds plausible analytics to the docs.

Reviewed-on: https://gitea.com/gitea/gitea-docusaurus/pulls/66
Reviewed-by: silverwind <silverwind@noreply.gitea.com>
Reviewed-by: delvh <dev.lh@web.de>
Co-authored-by: jolheiser <john.olheiser@gmail.com>
Co-committed-by: jolheiser <john.olheiser@gmail.com>
 2023-08-22 01:27:01 +00:00
John OlheiserGitHubGiteabot
 		c298cdba19 Add matrix to support (#26382) 
This PR adds our matrix space to the support options and alphabetizes
the list.

I also considered adding our Mastodon, however that isn't as suitable as
the other options because it's just whoever has access to the account vs
a community chat/forum.

---------

Signed-off-by: jolheiser <john.olheiser@gmail.com>
Co-authored-by: Giteabot <teabot@gitea.io>
 2023-08-12 16:54:50 +02:00
jolheiserandJohn Olheiser c24614753e Update primary color(s) (#53) 
Closes #35

One caveat, I used the docusaurus [styling and layout](https://docusaurus.io/docs/styling-layout/#styling-your-site-with-infima) color generator and fiddled until I could get a AA contrast ratio, so the colors aren't as exact as the one suggested in https://gitea.com/gitea/gitea-docusaurus/issues/35#issuecomment-742982 (But it still looks better than the blue-green we currently have imo)

![dark theme](/attachments/153c66eb-bdc6-4758-852c-f6a3beb45cdb)
![light theme](/attachments/c45495a8-e1ab-45a0-ab15-4bbdd887aea5)

Reviewed-on: https://gitea.com/gitea/gitea-docusaurus/pulls/53
Co-authored-by: jolheiser <john.olheiser@gmail.com>
Co-committed-by: jolheiser <john.olheiser@gmail.com>
 2023-07-27 23:49:16 +00:00
jolheiserandJohn Olheiser f397d309d2 Docusaurus-ify main repo (#51) 
https://github.com/go-gitea/gitea/pull/26051
https://github.com/go-gitea/gitea/pull/26052
https://github.com/go-gitea/gitea/pull/26053
Reviewed-on: https://gitea.com/gitea/gitea-docusaurus/pulls/51
Co-authored-by: jolheiser <john.olheiser@gmail.com>
Co-committed-by: jolheiser <john.olheiser@gmail.com>
 2023-07-27 14:55:46 +00:00
John OlheiserandGitHub 4834cfce21 Docusaurus-ify (#26051) 
This PR cleans up the docs in a way to make them simpler to ingest by
our [docs repo](https://gitea.com/gitea/gitea-docusaurus).

1. It includes all of the sed invocations our ingestion did, removing
the need to do it at build time.
2. It replaces the shortcode variable replacement method with
`@variable@` style, simply for easier sed invocations when required.
3. It removes unused files and moves the docs up a level as cleanup.

---------

Signed-off-by: jolheiser <john.olheiser@gmail.com>
 2023-07-26 04:53:13 +00:00
John OlheiserGitHubGiteabot
 		bd74711ecc Docusaurus-ify 1.19 (#26053) 
See https://github.com/go-gitea/gitea/pull/26051

---------

Signed-off-by: jolheiser <john.olheiser@gmail.com>
Co-authored-by: Giteabot <teabot@gitea.io>
 2023-07-26 10:01:15 +08:00
John OlheiserGitHubJonRB
 		e1991ac654 Docusaurus-ify 1.20 (#26052) 
See https://github.com/go-gitea/gitea/pull/26051

---------

Signed-off-by: jolheiser <john.olheiser@gmail.com>
Co-authored-by: JonRB <4564448+eeyrjmr@users.noreply.github.com>
 2023-07-26 10:00:14 +08:00
jolheiserandJohn Olheiser 78cc25c09d docs: add awesome and tea (#49) 
As title, add awesome-gitea and tea to the footer

Reviewed-on: https://gitea.com/gitea/gitea-docusaurus/pulls/49
Co-authored-by: jolheiser <john.olheiser@gmail.com>
Co-committed-by: jolheiser <john.olheiser@gmail.com>
 2023-07-21 15:15:51 +00:00
jolheiserandJohn Olheiser c77d0e0e34 Update footer (#48) 
Add more to community footer, change `More` to `Code` and add gitea.com, and remove `Docs` section that just linked back to home.

Reviewed-on: https://gitea.com/gitea/gitea-docusaurus/pulls/48
Co-authored-by: jolheiser <john.olheiser@gmail.com>
Co-committed-by: jolheiser <john.olheiser@gmail.com>
 2023-07-21 03:51:34 +00:00
John OlheiserandGitHub be1f9db476 Correctly refer to dev tags as nightly in the docker docs (#26004) 
As title, `dev` tags are no longer used since we switched to `nightly`

Signed-off-by: jolheiser <john.olheiser@gmail.com>
 2023-07-20 17:26:02 +08:00
John OlheiserandGitHub 92ff1589c2 Fix awesome-gitea link in 1.19 (#26006) 
As title, we still pull the docs for `1.19`.

Signed-off-by: jolheiser <john.olheiser@gmail.com>
 2023-07-20 14:30:11 +08:00
jolheiserandJohn Olheiser d3323cee1c fix: sed incantation for dl.gitea.com main-nightly (#26) 
Signed-off-by: jolheiser <john.olheiser@gmail.com>
Reviewed-on: https://gitea.com/gitea/gitea-docusaurus/pulls/26
Reviewed-by: techknowlogick <techknowlogick@noreply.gitea.com>
Co-authored-by: jolheiser <john.olheiser@gmail.com>
Co-committed-by: jolheiser <john.olheiser@gmail.com>
 2023-06-06 20:31:45 +00:00
jolheiserandJohn Olheiser 54ed2879c1 Fix sed incantation for empty (#23) 
Follow up for #22

Reviewed-on: https://gitea.com/gitea/gitea-docusaurus/pulls/23
Co-authored-by: jolheiser <john.olheiser@gmail.com>
Co-committed-by: jolheiser <john.olheiser@gmail.com>
 2023-05-30 19:10:17 +00:00
John OlheiserandGitHub 52aca7a6f2 Fix markdown link to awesome gitea (#25009) 
Fixes the markdown link and uses title case like the other
translations.
 2023-05-30 13:10:51 -05:00
jolheiserandtechknowlogick d3c11f4363 fix: update sed incantation for empty (#22) 
Should resolve #21

I cannot seem to get this to run properly on my machine, however this is an educated guess because the Chinese translation looks correct.

zh-cn
https://docs.gitea.com/zh-cn/administration/config-cheat-sheet#repository---release-repositoryrelease
https://gitea.com/gitea/gitea-docusaurus/src/commit/8c38ae516a72b802cc2889a507c824e0174f5256/loop_docs-zh-cn.sh#L11

en-us
https://docs.gitea.com/administration/config-cheat-sheet#repository---release-repositoryrelease
(check diff for current incantation)

Reviewed-on: https://gitea.com/gitea/gitea-docusaurus/pulls/22
Reviewed-by: techknowlogick <techknowlogick@noreply.gitea.com>
Co-authored-by: jolheiser <john.olheiser@gmail.com>
Co-committed-by: jolheiser <john.olheiser@gmail.com>
 2023-05-30 17:51:06 +00:00
John OlheiserandGitHub f072758afb Refactor docs (#23752) 
This was intended to be a small followup for
https://github.com/go-gitea/gitea/pull/23712, but...here we are.

1. Our docs currently use `slug` as the entire URL, which makes
refactoring tricky (see https://github.com/go-gitea/gitea/pull/23712).
Instead, this PR attempts to make future refactoring easier by using
slugs as an extension of the section. (Hugo terminology)
- What the above boils down to is this PR attempts to use directory
organization as URL management. e.g. `usage/comparison.en-us.md` ->
`en-us/usage/comparison/`, `usage/packages/overview.en-us.md` ->
`en-us/usage/packages/overview/`
- Technically we could even remove `slug`, as Hugo defaults to using
filename, however at least with this PR it means `slug` only needs to be
the name for the **current file** rather than an entire URL
2. This PR adds appropriate aliases (redirects) for pages, so anything
on the internet that links to our docs should hopefully not break.
3. A minor nit I've had for a while, renaming `seek-help` to `support`.
It's a minor thing, but `seek-help` has a strange connotation to it.
4. The commits are split such that you can review the first which is the
"actual" change, and the second is added redirects so that the first
doesn't break links elsewhere.

---------

Signed-off-by: jolheiser <john.olheiser@gmail.com>
 2023-04-28 11:33:41 +08:00
John OlheiserandGitHub 24c75e3fed Update PR documentation (#23620) 
This updates the PR docs and explains how to work with PRs, for those
who may not know.

It was mentioned that this page could explain PRs a bit better, in case
some users are not familiar with GitHub or similar forges.

Signed-off-by: jolheiser <john.olheiser@gmail.com>
 2023-03-21 18:05:52 -04:00
John OlheiserandGitHub 9f6c944206 Push option bonus for PTC docs (#23473) 
Follow-up for #23458 

I could have suggested this on the original PR, but I thought there
would be more to add. Hadn't noticed the push options docs already had
nearly the same shell command. 😅

Signed-off-by: jolheiser <john.olheiser@gmail.com>
 2023-03-14 19:12:27 +02:00
John OlheiserandGitHub 0cc38187a7 Add repo adoption to FAQ (#22778) 
This should be a simple set of steps to achieve
repo adoption.
 2023-02-06 10:20:20 -06:00
John OlheiserandGitHub 0445704f5f Update gogs upgrade information (#22777) 
It seems that migrating from Gogs `0.12.x` and above may require more
work as time goes on and the projects continue to diverge.

This PR updates the docs to make it more clear.

Signed-off-by: jolheiser <john.olheiser@gmail.com>
 2023-02-06 14:37:18 +08:00
John OlheiserandGitHub 008dd0ce21 docs: add swagger.json file location to FAQ (#22489) 
This just adds a mention on how to get the `swagger.json` for an
instance.

Signed-off-by: jolheiser <john.olheiser@gmail.com>
 2023-01-17 14:18:42 -06:00
John OlheiserandGitHub a7f964c118 Make app.ini read-only message more prominent (#21315) 2022-10-02 04:12:59 -04:00
John OlheiserandGitHub 8c678bf0aa Remove insecure flag from curl (#21074) 
Followup to #21071 
Thanks for the catch @wxiaoguang 

[WRT](https://github.com/go-gitea/gitea/pull/21071#discussion_r962706673)

Ref #21071
 2022-09-05 14:22:44 +01:00
John OlheiserandGitHub 99f20e0faa Update curl usage in API docs (#21071) 2022-09-05 03:22:03 -04:00
John OlheiserandGitHub 09f0632c74 Add Cloudflare auto-minify to FAQ (#20430) 2022-07-21 12:54:42 +08:00
John OlheiserandGitHub 199188dea3 MySQL 5 FAQ (#15729) 
* MySQL 5

Signed-off-by: jolheiser <john.olheiser@gmail.com>

* Wording
 2021-05-05 05:39:09 +01:00
John OlheiserandGitHub ab2dc27819 Fully qualify cloudron CSP (#13892) 
* Wildcard cloudron

Signed-off-by: jolheiser <john.olheiser@gmail.com>

* Just use FQDN

Signed-off-by: jolheiser <john.olheiser@gmail.com>
 2020-12-07 16:17:27 -06:00
John OlheiserandGitHub bc3c254112 Refactor docs (#13275) 
* First pass

Signed-off-by: jolheiser <john.olheiser@gmail.com>

* More changes

Signed-off-by: jolheiser <john.olheiser@gmail.com>

* Redirects

Signed-off-by: jolheiser <john.olheiser@gmail.com>
 2020-10-23 11:59:45 -04:00
John OlheiserGitHubAndrew Thornton
 		3841e371a2 hCaptcha Support (#12594) 
* Initial work on hCaptcha

Signed-off-by: jolheiser <john.olheiser@gmail.com>

* Use module

Signed-off-by: jolheiser <john.olheiser@gmail.com>

* Format

Signed-off-by: jolheiser <john.olheiser@gmail.com>

* At least return and debug log a captcha error

Signed-off-by: jolheiser <john.olheiser@gmail.com>

* Pass context to hCaptcha

Signed-off-by: jolheiser <john.olheiser@gmail.com>

* Add context to recaptcha

Signed-off-by: jolheiser <john.olheiser@gmail.com>

* fix lint

Signed-off-by: Andrew Thornton <art27@cantab.net>

* Finish hcaptcha

Signed-off-by: jolheiser <john.olheiser@gmail.com>

* Update example config

Signed-off-by: jolheiser <john.olheiser@gmail.com>

* Apply error fix for recaptcha

Signed-off-by: jolheiser <john.olheiser@gmail.com>

* Change recaptcha ChallengeTS to string

Signed-off-by: jolheiser <john.olheiser@gmail.com>

Co-authored-by: Andrew Thornton <art27@cantab.net>
 2020-10-02 23:37:53 -04:00
John OlheiserGitHubLunny Xiaotechknowlogick
 		5490cd5c0e Issue templates directory (#11450) 
* Issue templates

Signed-off-by: jolheiser <john.olheiser@gmail.com>

* Add some comments, appease the linter

Signed-off-by: jolheiser <john.olheiser@gmail.com>

* Add docs and re-use dir candidates

Signed-off-by: jolheiser <john.olheiser@gmail.com>

* Add default labels to issue templates

Signed-off-by: jolheiser <john.olheiser@gmail.com>

* Generate swagger

Signed-off-by: jolheiser <john.olheiser@gmail.com>

* Suggested changes

Signed-off-by: jolheiser <john.olheiser@gmail.com>

* Update issue.go

* Suggestions

Signed-off-by: jolheiser <john.olheiser@gmail.com>

* Extract metadata from legacy if possible

Signed-off-by: jolheiser <john.olheiser@gmail.com>

Co-authored-by: Lunny Xiao <xiaolunwen@gmail.com>
Co-authored-by: techknowlogick <techknowlogick@gitea.io>
 2020-09-11 10:48:39 -04:00
John OlheiserGitHubmrsdizziezeripath
 		cdc97c6330 Check passwords against HaveIBeenPwned (#12716) 
* Implement pwn

Signed-off-by: jolheiser <john.olheiser@gmail.com>

* Update module

Signed-off-by: jolheiser <john.olheiser@gmail.com>

* Apply suggestions mrsdizzie

Co-authored-by: mrsdizzie <info@mrsdizzie.com>

* Add link to HIBP

Signed-off-by: jolheiser <john.olheiser@gmail.com>

* Add more details to admin command

Signed-off-by: jolheiser <john.olheiser@gmail.com>

* Add context to pwn

Signed-off-by: jolheiser <john.olheiser@gmail.com>

* Consistency and making some noise ;)

Signed-off-by: jolheiser <john.olheiser@gmail.com>

Co-authored-by: mrsdizzie <info@mrsdizzie.com>
Co-authored-by: zeripath <art27@cantab.net>
 2020-09-08 17:06:39 -05:00
John OlheiserGitHubmrsdizzie
 		5619b0bbd3 Initial support for push options (#12169) 
* Initial support for push options

Signed-off-by: jolheiser <john.olheiser@gmail.com>

* Fix misspelling 🤦

Signed-off-by: jolheiser <john.olheiser@gmail.com>

* Fix formatting after conflict resolution

* defer close git repo

* According the GitLab documentation, git >= 2.10

Signed-off-by: jolheiser <john.olheiser@gmail.com>

* Words are hard. Thanks @mrsdizzie 😅

Co-authored-by: mrsdizzie <info@mrsdizzie.com>

* Only update if there are push options

Signed-off-by: jolheiser <john.olheiser@gmail.com>

Co-authored-by: mrsdizzie <info@mrsdizzie.com>
 2020-08-23 17:02:35 +01:00
John OlheiserGitHubguillep2k
 		a2bae20bea Allow site admin to disable mirrors (#11740) 
* Allow site admin to disable mirrors

Signed-off-by: jolheiser <john.olheiser@gmail.com>

* No need to run through Safe

Signed-off-by: jolheiser <john.olheiser@gmail.com>

* Clarify only disabling NEW mirrors

Signed-off-by: jolheiser <john.olheiser@gmail.com>

* Apply suggestions from @guillep2k

Co-authored-by: guillep2k <18600385+guillep2k@users.noreply.github.com>

Co-authored-by: guillep2k <18600385+guillep2k@users.noreply.github.com>
 2020-06-02 21:21:38 -04:00
John OlheiserGitHubtechknowlogick
 		2035f9504c Add localization docs (#11411) 
* Add localization docs

Signed-off-by: jolheiser <john.olheiser@gmail.com>

* Clarify bleeding edge vs release

Signed-off-by: jolheiser <john.olheiser@gmail.com>

* Capitalize Crowdin

Signed-off-by: jolheiser <john.olheiser@gmail.com>

Co-authored-by: techknowlogick <techknowlogick@gitea.io>
 2020-05-14 17:33:52 -04:00
John OlheiserandGitHub 61fa4c7d19 Add awesome-gitea reference on install from package docs (#11405) 
Signed-off-by: jolheiser <john.olheiser@gmail.com>
 2020-05-14 01:58:49 +03:00
John OlheiserandGitHub 4eca657f77 Remove test from installation directions (#10873) 
Signed-off-by: jolheiser <john.olheiser@gmail.com>
 2020-03-29 11:07:40 +01:00
John OlheiserandGitHub 2a72fb6aa9 Make PR message on pushes configurable (#10664) 
* Make PR message on pushes configurable

* Make fmt

Signed-off-by: jolheiser <john.olheiser@gmail.com>
 2020-03-08 08:34:38 -05:00
John OlheiserGitHubsilverwind
 		42639a8e32 Add node version variable to docs (#10620) 
Also adjusted other version mentions so go version is always mentioned
as major.minor and node only as major.

Co-authored-by: silverwind <me@silverwind.io>
 2020-03-05 16:36:22 -06:00
John OlheiserandGitHub 7b73adf12b Add FAQ for markdown (#10611) 
* Add FAQ for markdown

* Expand explanation @guillep2k

Signed-off-by: jolheiser <john.olheiser@gmail.com>
 2020-03-05 09:05:18 -06:00
John OlheiserandGitHub 6922e8cfa4 Re-order GPG signing docs and fix code blocks (#10349) 
* Move chunk and format

Signed-off-by: jolheiser <john.olheiser@gmail.com>

* word

Signed-off-by: jolheiser <john.olheiser@gmail.com>
 2020-02-19 02:23:45 +01:00