-
-
Notifications
You must be signed in to change notification settings - Fork 5.5k
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Remove docs sub folder since docs has been moved to https://gitea.com/gitea/docs #31536
Conversation
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Alternatively, which I'm more a fan of:
We push mirror https://gitea.com/gitea/docs
to https://github.com/go-gitea/docs
, and include it as a submodule here.
That's the best of both worlds (if we then add a workflow to update the main repo once the docs have been updated or at least daily)
As I said, I don't like it. If this merges, the dev doc change in #31521 would need to be split out into that docs repo and I'm really not thrilled to do such extra work. A major problem is that docs changes are no longer in sync with code changes and this asynchronity will introduce inaccuracies in the docs as they can no longer be reviewed along with the code change. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
looks document related github action should be removed also
Okay I sneaked in #31521 now, so I am no longer affected and hope I won't have to do many doc updates in the future. |
I created https://gitea.com/gitea/docs/pulls/16 to add the missing doc. |
I think I have removed all contents under |
+1 for submodule suggestion, as then it'll lessen the friction of contributions to docs (as then devs will at least have the repo already pulled down, and then docs writers can pull docs independently). |
I find submodules unergonomic to use and I don't see any benefit in having them as it still means that any feature that touches docs need to raise a second PR against the other repo and I guarantee many contributors will not go that extra mile. My vote is to split the docs into two: Keep configuration (the "cheat sheet") and contribution-related docs in the repo and split out another "website" repo (like this one) that holds less strictly reviewed content. |
I have said I will not be against the proposal. Please fire another issue or PR to do that. |
Fixed |
I’ll send the submodule PR shortly |
* giteaofficial/main: Fix: Allow org team names of length 255 in create team form (go-gitea#31564) Remove docs sub folder since docs has been moved to https://gitea.com/gitea/docs (go-gitea#31536) Add bohde as maintainer (go-gitea#31601) Add `YEAR`, `MONTH`, `MONTH_ENGLISH`, `DAY` variables for template repos (go-gitea#31584) Allow disabling authentication related user features (go-gitea#31535) Add back esbuild-loader for .js files (go-gitea#31585)
…31810) To help #31536. Or it's easy to forget to update https://gitea.com/gitea/docs when modifying `app.example.ini`.
No description provided.