Documentation finding report

[paulesco]

Hello devlake community,

I found a little error in the documentation and I was wondering how could I report or contribute to change it.

It is a little mistake, the domain layer schema diagram shows that refs.repo_id is an int, but it is a varchar, as the DW Detail says.
https://devlake.apache.org/docs/v1.0/DataModels/DevLakeDomainLayerSchema

Best,

Paul

[dosubot[bot]]

Hey @paulesco! 👋 I'm here to help you with any bugs, questions, or contributions you have in mind. I'm Dosu, a bot that's all about solving problems and making your experience a breeze.

To report or contribute to correcting the documentation error in the Apache DevLake domain layer schema where refs.repo_id is incorrectly shown as an int instead of a varchar, you can follow these steps:

1. Fork the Repository: Go to the incubator-devlake-website repository on GitHub and fork it to your own GitHub account.

2. Clone the Repository: Clone the forked repository to your local machine.

   git clone https://github.com/your-username/incubator-devlake-website.git
   cd incubator-devlake-website

3. Create a New Branch: Create a new branch for your changes.

   git checkout -b fix-repo-id-type

4. Edit the Documentation: Open the versioned_docs/version-v0.18/DataModels/DevLakeDomainLayerSchema.md file and correct the type of refs.repo_id from int to varchar.

   | `repo_id`    | varchar  | 255        | The id of repo this ref belongs to                                                                                                    | FK_repos.id |

5. Commit Your Changes: Commit the changes to your new branch.

   git add versioned_docs/version-v0.18/DataModels/DevLakeDomainLayerSchema.md
   git commit -m "Fix type of refs.repo_id from int to varchar"

6. Push Your Changes: Push the changes to your forked repository.

   git push origin fix-repo-id-type

7. Create a Pull Request: Go to the original incubator-devlake-website repository on GitHub and create a pull request from your forked repository's branch.

By following these steps, you can contribute to correcting the documentation error in the Apache DevLake domain layer schema ^{[1][2][3][4][5]}.

To continue talking to Dosu, mention @dosu.

[klesh]

@paulesco Hi, thanks for reporting the issue.
The answer from @dosubot is pretty solid, you may following the guide and submit your PR on https://github.com/apache/incubator-devlake-website

[paulesco]

Hello @klesh, thanks for your guidelines. I just created the PR, not exactly as the bot suggested, because I wanted to change the domain-layer-schema-diagram.svg image, which had the mistake, not the .md file.

[klesh]

@paulesco Great, thanks for your contribution.