incubator-devlake icon indicating copy to clipboard operation
incubator-devlake copied to clipboard
verified publisher icon apache

[Doc][main] Add a link to Official Website repo

Open klesh opened this issue 3 years ago • 3 comments

Documentation Scope

main readme

Describe the Change

We move all our document from main repo to Office Website Repo a while ago. However, some contributors from community never know about this. We should add a description of how to contribute documentation to our main README, along with a link to the Office Website Repo

klesh avatar Jul 26 '22 07:07 klesh

Hey @klesh, isn't How to Contribute already mentioned in the README ? I guess you are asking about mentioning docs being present on devlake.apache.org and not on the README ? I would like to work on this, please assign :)

iamppborah avatar Aug 07 '22 16:08 iamppborah

@ppborah Thanks! Here are the things we should do for developers who want to work on new features when reading main README:

  1. Developer should know Documentation is hosting on devlake.apache.org
  2. Developer should know How to contribute to the devlake.apache.org, in terms of which repo to submit documentation PR. (I ran into a situation where the contributor didn't know about apache/incubator-devlake-website repo at all)

klesh avatar Aug 08 '22 06:08 klesh

I got you! Working on it

iamppborah avatar Aug 11 '22 05:08 iamppborah

Hi, @ppborah, would you like to share the progress? Thanks

klesh avatar Aug 25 '22 01:08 klesh

Working on it @klesh, PR soon

iamppborah avatar Aug 25 '22 08:08 iamppborah

Hey @klesh, do you think we should be more descriptive or this would work ? Please let me know :)

PS: Initially, I thought of adding "Creating a PR using GitHub UI from Edit this page link", but then I felt it's better if we mention that on devLake-website repo's README.md

iamppborah avatar Sep 04 '22 18:09 iamppborah