Skip to content

Commit 6f1a810

Browse files
docs: Documentation updates prior to release candidate 2.0 release (#5068)
# Generic Pull Request Template - Add trailing slash to facilitate better versioning - push-latest for default docs config - updated pull request and issue templates - added `--pre` to install to allow for pre-release candidates - Added a changelog to 2.0 and mentioned it in 1.0 **Type of change** - Improvement (change adding some improvement to an existing functionality) - Documentation update **How Has This Been Tested** NA **Checklist** - [ ] I added relevant documentation - [ ] follows the style guidelines of this project - [ ] I did a self-review of my code - [ ] I made corresponding changes to the documentation - [ ] My changes generate no new warnings - [ ] I have added tests that prove my fix is effective or that my feature works - [ ] I filled out [the contributor form](https://tally.so/r/n9XrxK) (see text above) - [ ] I have added relevant notes to the CHANGELOG.md file (See https://keepachangelog.com/) --------- Co-authored-by: pre-commit-ci[bot] <66853113+pre-commit-ci[bot]@users.noreply.github.com>
1 parent d81a2c5 commit 6f1a810

File tree

22 files changed

+1152
-414
lines changed

22 files changed

+1152
-414
lines changed

.github/ISSUE_TEMPLATE/🆕-feature-request.md

Lines changed: 4 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -4,19 +4,16 @@ about: Cool new ideas for the project
44
title: "[FEATURE]"
55
labels: ''
66
assignees: ''
7-
87
---
98

10-
<!-- Ask David for help you to contribute https://calendly.com/argilla-office-hours/30min or feel free to submit a pull request straight away: https://github.com/argilla-io/argilla/pulls If you'd like to discuss your feature request or specific needs with our product team, contact Natalia Elvira in our slack community or book a slot with her: https://calendly.com/natalia-elvira/30min -->
11-
129
**Is your feature request related to a problem? Please describe.**
13-
A clear and concise description of what the problem is. Ex. I'm always frustrated when [...]
10+
<!-- A clear and concise description of what the problem is. Ex. I'm always frustrated when [...] -->
1411

1512
**Describe the solution you'd like**
16-
A clear and concise description of what you want to happen.
13+
<!-- A clear and concise description of what you want to happen. -->
1714

1815
**Describe alternatives you've considered**
19-
A clear and concise description of any alternative solutions or features you've considered.
16+
<!-- A clear and concise description of any alternative solutions or features you've considered. -->
2017

2118
**Additional context**
22-
Add any other context or screenshots about the feature request here.
19+
<!-- Add any other context or screenshots about the feature request here. -->

.github/ISSUE_TEMPLATE/🐞-bug-ui-ux.md

Lines changed: 7 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -4,34 +4,33 @@ about: UI or UX bugs and unexpected behavior
44
title: "[BUG-UI/UX]"
55
labels: ''
66
assignees: ''
7-
87
---
98

10-
<!-- Ask David for help you to contribute https://calendly.com/argilla-office-hours/30min or feel free to submit a pull request straight away: https://github.com/argilla-io/argilla/pulls or -->
11-
129
**Describe the bug**
13-
A clear and concise description of what the bug is.
10+
<!-- A clear and concise description of what the bug is. -->
1411

1512
**To Reproduce**
13+
<!--
1614
Steps to reproduce the behavior:
1715
1. Go to '...'
1816
2. Click on '....'
1917
3. Scroll down to '....'
2018
4. See error
19+
-->
2120

2221
**Expected behavior**
23-
A clear and concise description of what you expected to happen.
22+
<!-- A clear and concise description of what you expected to happen. -->
2423

2524
**Screenshots**
26-
If applicable, add screenshots to help explain your problem.
25+
<!-- If applicable, add screenshots to help explain your problem. -->
2726

28-
<!-- Since version 1.16.0 you can use `python -m argilla info` command to easily get the used versions -->
2927
**Environment (please complete the following information):**
28+
<!-- Since version 1.16.0 you can use `python -m argilla info` command to easily get the used versions -->
3029
- OS [e.g. iOS]:
3130
- Browser [e.g. chrome, safari]:
3231
- Argilla Version [e.g. 1.0.0]:
3332
- ElasticSearch Version [e.g. 7.10.2]:
3433
- Docker Image (optional) [e.g. argilla:v1.0.0]:
3534

3635
**Additional context**
37-
Add any other context about the problem here.
36+
<!-- Add any other context about the problem here. -->

.github/ISSUE_TEMPLATE/📚-add-a-documentation-report.md

Lines changed: 0 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -4,10 +4,7 @@ about: Have you spotted a typo or mistake in our docs?
44
title: "[DOCS]"
55
labels: ''
66
assignees: ''
7-
87
---
98

10-
<!-- Ask David for help you to contribute https://calendly.com/argilla-office-hours/30min or feel free to submit a pull request straight away: https://github.com/argilla-io/argilla/pulls or -->
11-
129
## Which page or section is this issue related to?
1310
<!-- Please include the URL and/or source. -->

.github/ISSUE_TEMPLATE/🪲-bug-python-deployment.md

Lines changed: 6 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -4,30 +4,29 @@ about: Python or Deployment bugs and unexpected behavior
44
title: "[BUG-python/deployment]"
55
labels: ''
66
assignees: ''
7-
87
---
98

10-
<!-- Ask David for help you to contribute https://calendly.com/argilla-office-hours/30min or feel free to submit a pull request straight away: https://github.com/argilla-io/argilla/pulls or -->
11-
129
**Describe the bug**
13-
A clear and concise description of what the bug is.
10+
<!-- A clear and concise description of what the bug is. -->
1411

1512
**Stacktrace and Code to create the bug**
13+
<!--
1614
```python
1715
my_python_code
1816
```
1917
```bash
2018
my_bash_code
2119
```
20+
-->
2221

2322
**Expected behavior**
24-
A clear and concise description of what you expected to happen.
23+
<!-- A clear and concise description of what you expected to happen. -->
2524

26-
<!-- Since version 1.16.0 you can use `python -m argilla info` command to easily get the used versions -->
2725
**Environment:**
26+
<!-- Since version 1.16.0 you can use `python -m argilla info` command to easily get the used versions -->
2827
- Argilla Version [e.g. 1.0.0]:
2928
- ElasticSearch Version [e.g. 7.10.2]:
3029
- Docker Image (optional) [e.g. argilla:v1.0.0]:
3130

3231
**Additional context**
33-
Add any other context about the problem here.
32+
<!-- Add any other context about the problem here. -->

.github/PULL_REQUEST_TEMPLATE/bug.md

Lines changed: 0 additions & 30 deletions
This file was deleted.

.github/PULL_REQUEST_TEMPLATE/docs.md

Lines changed: 0 additions & 29 deletions
This file was deleted.

.github/PULL_REQUEST_TEMPLATE/features.md

Lines changed: 0 additions & 33 deletions
This file was deleted.

.github/pull_request_template.md

Lines changed: 19 additions & 37 deletions
Original file line numberDiff line numberDiff line change
@@ -1,46 +1,28 @@
1-
# Argilla Community Growers
2-
3-
Thanks for your contribution! As part of our Community Growers initiative 🌱, we're donating Justdiggit bunds in your name to reforest sub-Saharan Africa. To claim your Community Growers certificate, please contact David Berenstein in our Slack community or fill in this form https://tally.so/r/n9XrxK once your PR has been merged.
4-
5-
# Pull Request Templates
6-
7-
Please go the the `Preview` tab and select the appropriate sub-template:
8-
9-
* [🐞-bug](?expand=1&template=bug.md)
10-
* [📚-documentation](?expand=1&template=docs.md)
11-
* [🆕-features](?expand=1&template=features.md)
12-
13-
# Generic Pull Request Template
14-
15-
Please include a summary of the changes and the related issue. Please also include relevant motivation and context. List any dependencies that are required for this change.
1+
# Pull Request Template
2+
<!-- Please include a summary of the changes and the related issue. Please also include relevant motivation and context. List any dependencies that are required for this change. -->
163

174
Closes #<issue_number>
185

196
**Type of change**
7+
<!-- Please delete options that are not relevant. Remember to title the PR according to the type of change -->
208

21-
(Please delete options that are not relevant. Remember to title the PR according to the type of change)
22-
23-
- [ ] Bug fix (non-breaking change which fixes an issue)
24-
- [ ] New feature (non-breaking change which adds functionality)
25-
- [ ] Breaking change (fix or feature that would cause existing functionality to not work as expected)
26-
- [ ] Refactor (change restructuring the codebase without changing functionality)
27-
- [ ] Improvement (change adding some improvement to an existing functionality)
28-
- [ ] Documentation update
9+
- Bug fix (non-breaking change which fixes an issue)
10+
- New feature (non-breaking change which adds functionality)
11+
- Breaking change (fix or feature that would cause existing functionality to not work as expected)
12+
- Refactor (change restructuring the codebase without changing functionality)
13+
- Improvement (change adding some improvement to an existing functionality)
14+
- Documentation update
2915

3016
**How Has This Been Tested**
31-
32-
(Please describe the tests that you ran to verify your changes. And ideally, reference `tests`)
33-
34-
- [ ] Test A
35-
- [ ] Test B
17+
<!-- Please add some reference about how your feature has been tested. -->
3618

3719
**Checklist**
38-
39-
- [ ] I added relevant documentation
40-
- [ ] follows the style guidelines of this project
41-
- [ ] I did a self-review of my code
42-
- [ ] I made corresponding changes to the documentation
43-
- [ ] My changes generate no new warnings
44-
- [ ] I have added tests that prove my fix is effective or that my feature works
45-
- [ ] I filled out [the contributor form](https://tally.so/r/n9XrxK) (see text above)
46-
- [ ] I have added relevant notes to the CHANGELOG.md file (See https://keepachangelog.com/)
20+
<!-- Please go over the list and make sure you've taken everything into account -->
21+
22+
- I added relevant documentation
23+
- follows the style guidelines of this project
24+
- I did a self-review of my code
25+
- I made corresponding changes to the documentation
26+
- I confirm My changes generate no new warnings
27+
- I have added tests that prove my fix is effective or that my feature works
28+
- I have added relevant notes to the CHANGELOG.md file (See https://keepachangelog.com/)

.github/workflows/argilla.docs.yml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -55,8 +55,8 @@ jobs:
5555
echo "${{ github.head_ref }}"
5656

5757
- run: |
58+
pdm run mike set-default --push latest
5859
pdm run mike deploy latest --push
59-
pdm run mike set-default latest
6060
if: github.ref == 'refs/heads/main'
6161
6262
- run: pdm run mike deploy dev --push

CONTRIBUTING.md

Lines changed: 1 addition & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -11,11 +11,9 @@ helped you, or simply ⭐️ the repository to say thank you.
1111
However you choose to contribute, please be mindful and respect our
1212
[code of conduct](https://github.com/argilla-io/argilla/blob/main/CODE_OF_CONDUCT.md).
1313

14-
For contributions, we work together to regreen the earth with [JustDiggit](https://justdiggit.org/) via our [Argilla Community Growers](https://argilla.io/blog/introducing-argilla-community-growers/) initiative.
15-
1614
## Need some help?
1715

18-
We understand that getting started might be scary and difficult, therefore, we provide a guided contributor mentorship program. Feel free to schedule a meeting [here](https://calendly.com/argilla-office-hours/30min) to get you started. Alternatively, you can start with [joining our Slack](https://join.slack.com/t/rubrixworkspace/shared_invite/zt-whigkyjn-a3IUJLD7gDbTZ0rKlvcJ5g) and reaching out in our [contributor channel](https://rubrixworkspace.slack.com/archives/C05BCGM277B).
16+
We understand that getting started might be scary and difficult, therefore, we provide a guided contributor mentorship program. Feel free to schedule a meeting [here](https://calendly.com/david-berenstein-huggingface/30min) to get you started. Alternatively, you can start with [joining our Slack](https://join.slack.com/t/rubrixworkspace/shared_invite/zt-whigkyjn-a3IUJLD7gDbTZ0rKlvcJ5g) and reaching out in our [contributor channel](https://rubrixworkspace.slack.com/archives/C05BCGM277B).
1917

2018
## Want to work on your own?
2119

0 commit comments

Comments
 (0)