Gitea: Proposal: Merge docs into this repo

Created on 6 Nov 2017  路  7Comments  路  Source: go-gitea/gitea

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.

kindocs kinproposal

Most helpful comment

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

All 7 comments

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

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.

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

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 .

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

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.

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

Was this page helpful?
0 / 5 - 0 ratings