Restructure documentation. Now the documentation has installation, administration, usage, development, contributing the 5 main parts #23629

lunny · 2023-03-22T08:18:08Z

Installation: includes how to install Gitea and related other tools, also includes upgrade Gitea
Administration: includes how to configure Gitea, customize Gitea and manage Gitea instance out of Gitea admin UI
Usage: includes how to use Gitea's functionalities. A sub documentation is about packages, in future we could also include CI/CD and others.
Development: includes how to integrate with Gitea's API, how to develop new features within Gitea
Contributing: includes how to contribute code to Gitea repositories.

After this is merged, I think we can have a sub-documentation of Usage part named Actions to describe how to use Gitea actions

…minister, usage, develop, contribute the 5 main parts

docs/Makefile

yardenshoham

Comparison seems out of place

delvh · 2023-03-22T10:43:21Z

Hmm, isn't Installation and Administer basically the same thing?
Could we perhaps combine them under Setup?

lunny · 2023-03-22T10:45:18Z

Hmm, isn't Installation and Administer basically the same thing? Could we perhaps combine them under Setup?

I think you are right. But I move them as standalone documentation according to most people's habits.

lunny · 2023-03-22T10:47:28Z

Comparison seems out of place

Looks like we need to change the theme about the style.

wxiaoguang · 2023-03-22T10:48:07Z

I think separating Installation from Administer is more friendly for new users.

Makefile

docs/content/doc/packages/rubygems.en-us.md

docs/content/doc/pacakges.md

delvh · 2023-03-22T11:31:06Z

By the way, should we backport this PR to 1.19?
As we are moving towards versioned docs, it would also be nice there…

wxiaoguang · 2023-03-22T11:32:12Z

And I also have a (similar) question, what's the progress of Versioned Document? Does this change work with Versioned Document (how does it work with 1.19)?

lunny · 2023-03-22T12:00:59Z

And I also have a (similar) question, what's the progress of Versioned Document? Does this change work with Versioned Document (how does it work with 1.19)?

The versioned document repository is https://gitea.com/gitea/gitea-docusaurus . I think after this merged, it needs some adjustments. @techknowlogick

lunny · 2023-03-22T12:02:37Z

Looks like there is no new feature merged after 1.19 branch created, so I think yes, we can backport this to 1.19 to make versioned documentation easier.

yardenshoham · 2023-03-22T13:07:26Z

Makefile

@@ -817,7 +818,7 @@ release-docs: | $(DIST_DIRS) docs
 .PHONY: docs
 docs:
 	@hash hugo > /dev/null 2>&1; if [ $$? -ne 0 ]; then \
-		curl -sL https://github.com/gohugoio/hugo/releases/download/v0.111.3/hugo_0.111.3_Linux-64bit.tar.gz | tar zxf - -C /tmp && mv /tmp/hugo /usr/bin/hugo && chmod +x /usr/bin/hugo; \
+		curl -sL https://github.com/gohugoio/hugo/releases/download/v$(HUGO_VERSION)/hugo_$(HUGO_VERSION)_Linux-64bit.tar.gz | tar zxf - -C /tmp && mv /tmp/hugo /usr/bin/hugo && chmod +x /usr/bin/hugo; \


This will break Gitpod. It's fine, I guess I will fix it after this is merged

Actually, this variable isn't used anywhere else so I'd rather just keeping the version hardcoded here

Since I have changed that and if it's equal. Maybe just leave it.

jolheiser · 2023-03-22T13:52:12Z

We should find a spot for comparison before merging this.

Either by changing the theme, adding it to the index, or adding it to another section.

delvh · 2023-03-22T13:53:19Z

Usage/Installation?

jolheiser

As well, I think "Help" should be moved back to the top imo

docs/content/doc/usage/secrets.en-us.md

lunny · 2023-03-23T04:17:28Z

I think it should be Contributing but Contibution

yardenshoham · 2023-03-23T07:33:57Z

I agree, let's do:

Installation
Administration
Usage
Development
Contributing

lunny · 2023-03-23T09:45:47Z

As well, I think "Help" should be moved back to the top imo

I have a different thought about moving help in the last. The FAQ should be read after users read all the documentation but with no answer. And support chat channel should also be given when users cannot find the answer from the documentation. They are not encouraged to ask in the chatroom before they read the documentation carefully.

… -> administration

GiteaBot · 2023-03-23T15:19:36Z

I was unable to create a backport for 1.19, please send one manually. 🍵

… -> administration (#23662) backport #23629 To make versioned documentation less surprising, 1.19 should have the same technology.

* upstream/main: Fix incorrect `HookEventType` of pull request review comments (go-gitea#23650) [skip ci] Updated translations via Crowdin Fix codeblocks in the cheat sheet (go-gitea#23664) Drop migration for ForeignReference (go-gitea#23605) Fix new issue/pull request btn margin when it is next to sort (go-gitea#23647) A tool to help to backport locales, changes source strings to fix other broken translations (go-gitea#23633) Fix incorrect `show-modal` and `show-panel` class (go-gitea#23660) Restructure documentation. Now the documentation has installation, administration, usage, development, contributing the 5 main parts (go-gitea#23629) Check LFS/Packages settings in dump and doctor command (go-gitea#23631) Use a general approach to show tooltip, fix temporary tooltip bug (go-gitea#23574) Improve workflow event triggers (go-gitea#23613) Improve `<SvgIcon>` to make it output `svg` node and optimize performance (go-gitea#23570)

Refactored `deps-docs` out of `docs` because `go-gitea#23629` broke Gitpod's docs setup (which grepped to get the hugo install command).

package doc link is changed in #23629

package doc link is changed in go-gitea#23629

Refactored `deps-docs` out of `docs` because #23629 broke Gitpod's docs setup (which grepped to get the hugo install command). Now `make deps` really installs everything to develop (includes `docs`).

@yp05327

Backport #23679 by @yp05327 package doc link is changed in #23629 Co-authored-by: yp05327 <576951401@qq.com>

Restructure documentation. Now the documentation has installation, ad…

344c4f8

…minister, usage, develop, contribute the 5 main parts

lunny added type/docs This PR mainly updates/creates documentation pr/wip This PR is not ready for review labels Mar 22, 2023

lunny added 3 commits March 22, 2023 16:26

Move guidelines to right places

126ed83

Fix wrong ref

42ad84d

Adjust sequence

5e379f1

yardenshoham suggested changes Mar 22, 2023

View reviewed changes

docs/Makefile Outdated Show resolved Hide resolved

GiteaBot added the lgtm/need 2 This PR needs two approvals by maintainers to be considered for merging. label Mar 22, 2023

Upgrade hugo version

b96ed19

lunny removed the pr/wip This PR is not ready for review label Mar 22, 2023

yardenshoham reviewed Mar 22, 2023

View reviewed changes

delvh reviewed Mar 22, 2023

View reviewed changes

Makefile Outdated Show resolved Hide resolved

docs/content/doc/packages/rubygems.en-us.md Outdated Show resolved Hide resolved

docs/content/doc/pacakges.md Outdated Show resolved Hide resolved

lunny added the outdated/backport/v1.19 This PR should be backported to Gitea 1.19 label Mar 22, 2023

lunny added 2 commits March 22, 2023 20:06

Fix typo

829afff

hugo version in makefile

971944e

yardenshoham reviewed Mar 22, 2023

View reviewed changes

delvh approved these changes Mar 22, 2023

View reviewed changes

GiteaBot added lgtm/need 1 This PR needs approval from one additional maintainer to be merged. and removed lgtm/need 2 This PR needs two approvals by maintainers to be considered for merging. labels Mar 22, 2023

jolheiser requested changes Mar 22, 2023

View reviewed changes

docs/content/doc/usage/secrets.en-us.md Outdated Show resolved Hide resolved

docs/content/doc/usage/secrets.en-us.md Outdated Show resolved Hide resolved

lunny added 2 commits March 23, 2023 17:54

rename develop -> development, contribute -> contributing, administer…

0f46fd8

… -> administration

Merge branch 'main' into lunny/restructure_docs

bd0135f

lunny changed the title ~~Restructure documentation. Now the documentation has installation, administer, usage, develop, contribute the 5 main parts~~ Restructure documentation. Now the documentation has installation, administration, usage, development, contributing the 5 main parts Mar 23, 2023

jolheiser approved these changes Mar 23, 2023

View reviewed changes

GiteaBot added lgtm/done This PR has enough approvals to get merged. There are no important open reservations anymore. and removed lgtm/need 1 This PR needs approval from one additional maintainer to be merged. labels Mar 23, 2023

Merge branch 'main' into lunny/restructure_docs

5568f2b

lunny merged commit e8433b7 into go-gitea:main Mar 23, 2023

lunny deleted the lunny/restructure_docs branch March 23, 2023 15:18

GiteaBot added the backport/manual No power to the bots! Create your backport yourself! label Mar 23, 2023

lunny mentioned this pull request Mar 23, 2023

Rename develop -> development, contribute -> contributing, administer -> administration #23662

Merged

lunny added the backport/done All backports for this PR have been created label Mar 23, 2023

jolheiser pushed a commit that referenced this pull request Mar 23, 2023

Rename develop -> development, contribute -> contributing, administer…

162f284

… -> administration (#23662) backport #23629 To make versioned documentation less surprising, 1.19 should have the same technology.

This was referenced Mar 24, 2023

docs: HTTPS configuration for zh-cn #23039

Merged

Fix incorrect package doc link #23679

Merged

yardenshoham added a commit to yardenshoham/gitea that referenced this pull request Mar 24, 2023

Add deps-docs command to makefile

169f31e

Refactored `deps-docs` out of `docs` because `go-gitea#23629` broke Gitpod's docs setup (which grepped to get the hugo install command).

yardenshoham mentioned this pull request Mar 24, 2023

Add deps-docs command to makefile #23686

Merged

lunny pushed a commit that referenced this pull request Mar 24, 2023

Fix incorrect package doc link (#23679)

d673a6f

package doc link is changed in #23629

GiteaBot mentioned this pull request Mar 24, 2023

Fix incorrect package doc link (#23679) #23689

Merged

GiteaBot pushed a commit to GiteaBot/gitea that referenced this pull request Mar 24, 2023

Fix incorrect package doc link (go-gitea#23679)

a1d7a11

package doc link is changed in go-gitea#23629

techknowlogick pushed a commit that referenced this pull request Mar 24, 2023

Fix incorrect package doc link (#23679) (#23689)

484cb22

Backport #23679 by @yp05327 package doc link is changed in #23629 Co-authored-by: yp05327 <576951401@qq.com>

delvh added this to the 1.20.0 milestone Apr 3, 2023

go-gitea locked and limited conversation to collaborators May 3, 2023

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Restructure documentation. Now the documentation has installation, administration, usage, development, contributing the 5 main parts #23629

Restructure documentation. Now the documentation has installation, administration, usage, development, contributing the 5 main parts #23629

lunny commented Mar 22, 2023 •

edited

Loading

yardenshoham left a comment

delvh commented Mar 22, 2023

lunny commented Mar 22, 2023

lunny commented Mar 22, 2023

wxiaoguang commented Mar 22, 2023 •

edited

Loading

delvh commented Mar 22, 2023

wxiaoguang commented Mar 22, 2023

lunny commented Mar 22, 2023 •

edited

Loading

lunny commented Mar 22, 2023

yardenshoham Mar 22, 2023

yardenshoham Mar 22, 2023

lunny Mar 23, 2023

jolheiser commented Mar 22, 2023

delvh commented Mar 22, 2023 •

edited

Loading

jolheiser left a comment

lunny commented Mar 23, 2023

yardenshoham commented Mar 23, 2023

lunny commented Mar 23, 2023

GiteaBot commented Mar 23, 2023

Restructure documentation. Now the documentation has installation, administration, usage, development, contributing the 5 main parts #23629

Restructure documentation. Now the documentation has installation, administration, usage, development, contributing the 5 main parts #23629

Conversation

lunny commented Mar 22, 2023 • edited Loading

yardenshoham left a comment

Choose a reason for hiding this comment

delvh commented Mar 22, 2023

lunny commented Mar 22, 2023

lunny commented Mar 22, 2023

wxiaoguang commented Mar 22, 2023 • edited Loading

delvh commented Mar 22, 2023

wxiaoguang commented Mar 22, 2023

lunny commented Mar 22, 2023 • edited Loading

lunny commented Mar 22, 2023

yardenshoham Mar 22, 2023

Choose a reason for hiding this comment

yardenshoham Mar 22, 2023

Choose a reason for hiding this comment

lunny Mar 23, 2023

Choose a reason for hiding this comment

jolheiser commented Mar 22, 2023

delvh commented Mar 22, 2023 • edited Loading

jolheiser left a comment

Choose a reason for hiding this comment

lunny commented Mar 23, 2023

yardenshoham commented Mar 23, 2023

lunny commented Mar 23, 2023

GiteaBot commented Mar 23, 2023

lunny commented Mar 22, 2023 •

edited

Loading

wxiaoguang commented Mar 22, 2023 •

edited

Loading

lunny commented Mar 22, 2023 •

edited

Loading

delvh commented Mar 22, 2023 •

edited

Loading