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

Suggestion: Merge this repo into https://github.com/alibaba/higress #53

Open
spacewander opened this issue Dec 26, 2022 · 2 comments
Open

Comments

@spacewander
Copy link
Contributor

Many famous open source projects put the doc into the same repo of the source code. For instance:
APISIX: https://github.com/apache/apisix/tree/master/docs
Envoy: https://github.com/envoyproxy/envoy/tree/main/docs

Some projects even put the website into the same repo:
Pulsar: https://github.com/apache/pulsar/tree/master/site2/website

Here I suggest higress merge this repo into https://github.com/alibaba/higress.

Pros:

  1. People can update the doc in the same PR as the code change
  2. More activities can happen in the one repo
  3. It's easier for people to open the issue in the correct place. All issues (for doc / for code / for website) can go to one place and there is no need to move/track them in several places.

Cons:

  1. Increase the main repo's size. But this is trivial under the developer's modern network environment.
@johnlanni
Copy link
Contributor

Thanks for the suggestion, this is a website project and we are planning to refactor with the new website framework, this will be taken into account when refactoring.

@tomkerkhove
Copy link
Contributor

+1

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

3 participants