https://github.com/equinor/dm-docs
Documentation for Data Modelling
https://github.com/equinor/dm-docs
documentation
Last synced: about 1 year ago
JSON representation
Documentation for Data Modelling
- Host: GitHub
- URL: https://github.com/equinor/dm-docs
- Owner: equinor
- License: mit
- Created: 2022-09-28T06:39:02.000Z (over 3 years ago)
- Default Branch: main
- Last Pushed: 2024-06-03T11:48:58.000Z (about 2 years ago)
- Last Synced: 2024-06-03T13:36:22.266Z (about 2 years ago)
- Topics: documentation
- Language: Shell
- Homepage: https://equinor.github.io/dm-docs/
- Size: 16.4 MB
- Stars: 3
- Watchers: 2
- Forks: 1
- Open Issues: 4
-
Metadata Files:
- Readme: README.md
- Contributing: CONTRIBUTING.md
- License: LICENSE
- Codeowners: .github/CODEOWNERS
- Security: SECURITY.md
Awesome Lists containing this project
README
# Data Modelling Docs
[![License][license-badge]][license]
[build docs](https://github.com/equinor/dm-docs/actions/workflows/on-push-main.yml/badge.svg?branch=main)
## Documentation
You can find the Data Modelling documentation at [https://equinor.github.io/dm-docs](https://equinor.github.io/dm-docs).
## Developing
See [docs/README.md](./docs/README.md) for instructions on extending the documentation.
### Pre-commit
We use pre-commit to do a minimum of checks on the developer pc before committing. The same checks, plus a few more are
also run in the build pipeline. You should catch any errors early to save time.
Setup;
```shell
pip install pre-commit # Should be installed in global python environment
pre-commit install # Pre-commit will now run on every commit (can be skipped with 'git commit --no-verify')
# To run manually on all files
pre-commit run -a
```
## Contributing
Read our [contributors' guide](https://equinor.github.io/dm-docs/contributing) to get started.
[license-badge]: https://img.shields.io/badge/License-MIT-yellow.svg
[license]: https://github.com/equinor/dm-docs/blob/master/LICENSE
[releases]: https://github.com/equinor/dm-docs/releases