Skip to content
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

Merged
merged 6 commits into from
Jul 10, 2024

Conversation

lunny
Copy link
Member

@lunny lunny commented Jul 2, 2024

No description provided.

@lunny lunny added the type/docs This PR mainly updates/creates documentation label Jul 2, 2024
@GiteaBot GiteaBot added the lgtm/need 2 This PR needs two approvals by maintainers to be considered for merging. label Jul 2, 2024
@pull-request-size pull-request-size bot added the size/XXL Denotes a PR that changes 1000+ lines, ignoring generated files. label Jul 2, 2024
Copy link
Member

@delvh delvh left a 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)

@GiteaBot 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 Jul 2, 2024
@silverwind
Copy link
Member

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.

Copy link
Member

@a1012112796 a1012112796 left a 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

@silverwind
Copy link
Member

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.

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.

@lunny
Copy link
Member Author

lunny commented Jul 4, 2024

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.

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.

@lunny
Copy link
Member Author

lunny commented Jul 4, 2024

looks document related github action should be removed also

I think I have removed all contents under docs/.

@yp05327
Copy link
Contributor

yp05327 commented Jul 4, 2024

looks document related github action should be removed also

I think I have removed all contents under docs/.

image

@techknowlogick
Copy link
Member

+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).

@silverwind
Copy link
Member

silverwind commented Jul 5, 2024

+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.

@lunny
Copy link
Member Author

lunny commented Jul 5, 2024

+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.
But for this PR it can be merged ASAP to make less confustion.

@lunny
Copy link
Member Author

lunny commented Jul 5, 2024

looks document related github action should be removed also

Fixed

@GiteaBot 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 Jul 10, 2024
@techknowlogick
Copy link
Member

I’ll send the submodule PR shortly

@techknowlogick techknowlogick enabled auto-merge (squash) July 10, 2024 00:00
@lunny lunny added the reviewed/wait-merge This pull request is part of the merge queue. It will be merged soon. label Jul 10, 2024
@techknowlogick techknowlogick merged commit af1f0df into go-gitea:main Jul 10, 2024
26 checks passed
@GiteaBot GiteaBot added this to the 1.23.0 milestone Jul 10, 2024
@GiteaBot GiteaBot removed the reviewed/wait-merge This pull request is part of the merge queue. It will be merged soon. label Jul 10, 2024
zjjhot added a commit to zjjhot/gitea that referenced this pull request Jul 10, 2024
* 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)
@lunny lunny deleted the lunny/remove_docs branch July 10, 2024 03:16
lunny pushed a commit that referenced this pull request Aug 9, 2024
…31810)

To help #31536.

Or it's easy to forget to update https://gitea.com/gitea/docs when
modifying `app.example.ini`.
@go-gitea go-gitea locked as resolved and limited conversation to collaborators Oct 8, 2024
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
lgtm/done This PR has enough approvals to get merged. There are no important open reservations anymore. modifies/docs modifies/internal size/XXL Denotes a PR that changes 1000+ lines, ignoring generated files. type/docs This PR mainly updates/creates documentation
Projects
None yet
Development

Successfully merging this pull request may close these issues.

7 participants