Skip to content

Commit

Permalink
docs: Documentation updates prior to release candidate 2.0 release (#…
Browse files Browse the repository at this point in the history
…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>
  • Loading branch information
davidberenstein1957 and pre-commit-ci[bot] authored Jun 20, 2024
1 parent d81a2c5 commit 6f1a810
Show file tree
Hide file tree
Showing 22 changed files with 1,152 additions and 414 deletions.
11 changes: 4 additions & 7 deletions .github/ISSUE_TEMPLATE/🆕-feature-request.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,19 +4,16 @@ about: Cool new ideas for the project
title: "[FEATURE]"
labels: ''
assignees: ''

---

<!-- 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 -->

**Is your feature request related to a problem? Please describe.**
A clear and concise description of what the problem is. Ex. I'm always frustrated when [...]
<!-- A clear and concise description of what the problem is. Ex. I'm always frustrated when [...] -->

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

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

**Additional context**
Add any other context or screenshots about the feature request here.
<!-- Add any other context or screenshots about the feature request here. -->
15 changes: 7 additions & 8 deletions .github/ISSUE_TEMPLATE/🐞-bug-ui-ux.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,34 +4,33 @@ about: UI or UX bugs and unexpected behavior
title: "[BUG-UI/UX]"
labels: ''
assignees: ''

---

<!-- 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 -->

**Describe the bug**
A clear and concise description of what the bug is.
<!-- A clear and concise description of what the bug is. -->

**To Reproduce**
<!--
Steps to reproduce the behavior:
1. Go to '...'
2. Click on '....'
3. Scroll down to '....'
4. See error
-->

**Expected behavior**
A clear and concise description of what you expected to happen.
<!-- A clear and concise description of what you expected to happen. -->

**Screenshots**
If applicable, add screenshots to help explain your problem.
<!-- If applicable, add screenshots to help explain your problem. -->

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

**Additional context**
Add any other context about the problem here.
<!-- Add any other context about the problem here. -->
3 changes: 0 additions & 3 deletions .github/ISSUE_TEMPLATE/📚-add-a-documentation-report.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,10 +4,7 @@ about: Have you spotted a typo or mistake in our docs?
title: "[DOCS]"
labels: ''
assignees: ''

---

<!-- 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 -->

## Which page or section is this issue related to?
<!-- Please include the URL and/or source. -->
13 changes: 6 additions & 7 deletions .github/ISSUE_TEMPLATE/🪲-bug-python-deployment.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,30 +4,29 @@ about: Python or Deployment bugs and unexpected behavior
title: "[BUG-python/deployment]"
labels: ''
assignees: ''

---

<!-- 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 -->

**Describe the bug**
A clear and concise description of what the bug is.
<!-- A clear and concise description of what the bug is. -->

**Stacktrace and Code to create the bug**
<!--
```python
my_python_code
```
```bash
my_bash_code
```
-->

**Expected behavior**
A clear and concise description of what you expected to happen.
<!-- A clear and concise description of what you expected to happen. -->

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

**Additional context**
Add any other context about the problem here.
<!-- Add any other context about the problem here. -->
30 changes: 0 additions & 30 deletions .github/PULL_REQUEST_TEMPLATE/bug.md

This file was deleted.

29 changes: 0 additions & 29 deletions .github/PULL_REQUEST_TEMPLATE/docs.md

This file was deleted.

33 changes: 0 additions & 33 deletions .github/PULL_REQUEST_TEMPLATE/features.md

This file was deleted.

56 changes: 19 additions & 37 deletions .github/pull_request_template.md
Original file line number Diff line number Diff line change
@@ -1,46 +1,28 @@
# Argilla Community Growers

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.

# Pull Request Templates

Please go the the `Preview` tab and select the appropriate sub-template:

* [🐞-bug](?expand=1&template=bug.md)
* [📚-documentation](?expand=1&template=docs.md)
* [🆕-features](?expand=1&template=features.md)

# Generic Pull Request Template

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.
# Pull Request Template
<!-- 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. -->

Closes #<issue_number>

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

(Please delete options that are not relevant. Remember to title the PR according to the type of change)

- [ ] Bug fix (non-breaking change which fixes an issue)
- [ ] New feature (non-breaking change which adds functionality)
- [ ] Breaking change (fix or feature that would cause existing functionality to not work as expected)
- [ ] Refactor (change restructuring the codebase without changing functionality)
- [ ] Improvement (change adding some improvement to an existing functionality)
- [ ] Documentation update
- Bug fix (non-breaking change which fixes an issue)
- New feature (non-breaking change which adds functionality)
- Breaking change (fix or feature that would cause existing functionality to not work as expected)
- Refactor (change restructuring the codebase without changing functionality)
- Improvement (change adding some improvement to an existing functionality)
- Documentation update

**How Has This Been Tested**

(Please describe the tests that you ran to verify your changes. And ideally, reference `tests`)

- [ ] Test A
- [ ] Test B
<!-- Please add some reference about how your feature has been tested. -->

**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/)
<!-- Please go over the list and make sure you've taken everything into account -->

- 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
- I confirm My changes generate no new warnings
- I have added tests that prove my fix is effective or that my feature works
- I have added relevant notes to the CHANGELOG.md file (See https://keepachangelog.com/)
2 changes: 1 addition & 1 deletion .github/workflows/argilla.docs.yml
Original file line number Diff line number Diff line change
Expand Up @@ -55,8 +55,8 @@ jobs:
echo "${{ github.head_ref }}"

- run: |
pdm run mike set-default --push latest
pdm run mike deploy latest --push
pdm run mike set-default latest
if: github.ref == 'refs/heads/main'
- run: pdm run mike deploy dev --push
Expand Down
4 changes: 1 addition & 3 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -11,11 +11,9 @@ helped you, or simply ⭐️ the repository to say thank you.
However you choose to contribute, please be mindful and respect our
[code of conduct](https://github.com/argilla-io/argilla/blob/main/CODE_OF_CONDUCT.md).

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.

## Need some help?

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).
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).

## Want to work on your own?

Expand Down
Loading

0 comments on commit 6f1a810

Please sign in to comment.