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

Proposal: Merge docs into this repo #2865

Closed
techknowlogick opened this issue Nov 6, 2017 · 7 comments · Fixed by #2874
Closed

Proposal: Merge docs into this repo #2865

techknowlogick opened this issue Nov 6, 2017 · 7 comments · Fixed by #2874
Labels
type/docs This PR mainly updates/creates documentation type/proposal The new feature has not been accepted yet but needs to be discussed first.
Milestone

Comments

@techknowlogick
Copy link
Member

This is a thought I have had (as well as it has been mentioned in discord by others), but perhaps the docs repo should be merged into this repo.

Some pros of this:

  • When submitting PRs, devs can submit docs in same commit (this reduces friction for su
  • An extra step to drone can happen on merges that autobuild and push docs (to keep them fresh)

I'd be open to making a PR for this, however my (simple) approach would be to create a docs folder, and just dump a copy of HEAD into it, this may lose history though.

@lafriks
Copy link
Member

lafriks commented Nov 6, 2017

docker yml also need to be updated so that docs site is updated from main repository

@andreynering
Copy link
Contributor

Thanks for your suggestion. Here's my opinion:

I kind of like the idea for small projects. But Gitea is big and is cleaner to have code/issues/PRs separated IMHO.

Also, some Gitea users may not know Go, but may like to contribute to docs. They currently don't need to clone 5,700+ commits to do it.

I'd be open to making a PR for this, however my (simple) approach would be to create a docs folder, and just dump a copy of HEAD into it, this may lose history though.

With Git Subtrees would be possible to merge the repos preserving the history.

@andreynering andreynering added type/docs This PR mainly updates/creates documentation type/proposal The new feature has not been accepted yet but needs to be discussed first. labels Nov 7, 2017
@lafriks
Copy link
Member

lafriks commented Nov 7, 2017

Idea for moving docs to main repo is to be able submit documentation together with updated code otherwise docs stay out of date

@lunny
Copy link
Member

lunny commented Nov 7, 2017

So maybe send docs commit from docs repo to gitea repo via giteabot when commit pushed to CI. We almost declaim docs repo and docs.gitea.io keep the latest documents. And you can find history docs on your gitea instance /docs .

@lafriks
Copy link
Member

lafriks commented Nov 7, 2017

For me target is to get docs updated when new features are implemented and having it other repository just gets into way as nobody is willing to submit other PR to update docs

@techknowlogick
Copy link
Member Author

Thinking about this now, I probably don't need to bring history over as when PRs are accepted they are squashed to that history would be lost anyway. So I'll submit a PR with what's in HEAD tonight.

@techknowlogick
Copy link
Member Author

I've submitted the PR, and merged it's drone file and the main repositories.

@lunny lunny added this to the 1.4.0 milestone Nov 27, 2017
@go-gitea go-gitea locked and limited conversation to collaborators Nov 23, 2020
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
type/docs This PR mainly updates/creates documentation type/proposal The new feature has not been accepted yet but needs to be discussed first.
Projects
None yet
Development

Successfully merging a pull request may close this issue.

4 participants