Skip to content

Commit

Permalink
fix(grammatical): Spelling mistakes (#4057)
Browse files Browse the repository at this point in the history
# 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.

Closes #<issue_number>

**Type of change**

This pull request addresses and corrects several grammatical errors
found throughout the codebase.
The changes include fixing typos, punctuation, and ensuring proper
sentence structure for improved readability and clarity.


- [ ] 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

**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/)
  • Loading branch information
AbhineshJha authored Oct 26, 2023
1 parent c1db4b4 commit 38c2799
Show file tree
Hide file tree
Showing 3 changed files with 7 additions and 7 deletions.
2 changes: 1 addition & 1 deletion docs/_source/community/developer_docs.md
Original file line number Diff line number Diff line change
Expand Up @@ -166,7 +166,7 @@ conda activate argilla

In the new Conda environment, Argilla will already be installed in editable mode with all the server dependencies. But if you’re willing to install any other dependency you can do so via `pip` to install your own, or just see the available extras besides the `server` extras, which are: `listeners`, `postgresql`, and `tests`; all those installable as `pip install -e ".[<EXTRA_NAME>]"`.

Now, the Argilla package is set up on your system and you need to make further installments for a thorough development setup.
Now, the Argilla package is set up on your system and you need to make further installations for a thorough development setup.

### Install Code Formatting Tools

Expand Down
4 changes: 2 additions & 2 deletions docs/_source/community/migration-rubrix.md
Original file line number Diff line number Diff line change
Expand Up @@ -32,7 +32,7 @@ All the environment variables have changed from using the prefix `RUBRIX_` to us
.. warning::
From version `1.13.0`, the support for non-prefixed environment variables has been removed. All environment variables must be prefixed with `ARGILLA_`.

The best to configure a new Argilla Server from Rubrix is just to duplicate all ENV variables for
The best way to configure a new Argilla Server from Rubrix is just to duplicate all ENV variables for
both, Rubrix and Argilla instances. This will simplify a version rollback if needed.

## New Elasticsearch index naming conventions
Expand All @@ -57,7 +57,7 @@ ARGILLA_ENABLE_MIGRATION=1 argilla server start
This will fetch info contained in the Rubrix instance `.rubrix.datasetsw-v0` index and
will copy the info into the new `ar.datasets` index.

Then, for each old rubrix index, will create an alias with new new name convention format.
Then, for each old rubrix index, will create an alias with new naming convention format.

This will allow you to work with previous Rubrix datasets from your new Argilla Server without duplicating information and still see the changes from your previous Rubrix Server.

Expand Down
8 changes: 4 additions & 4 deletions docs/migration-rubrix.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@ If you have already running a Rubrix server and want to upgrade to the new Argil
## Python module and command

The module now is called `argilla` instead of `rubrix`, but the rest of the code remains fully compatible, so
if you have to updgrade some codebase, you should just replace the line:
if you have to upgrade some codebase, you should just replace the line:

`import rubrix...`

Expand Down Expand Up @@ -42,7 +42,7 @@ Argilla also introduces a new name convention for the stored indices in Elastics
For the index pattern containing all created datasets, the new namespace is `ar.datasets`, instead of `.rubrix.datasets-v0`

For indices containing the dataset records, the new name convention is `ar.dataset.<dataset_id>`, instead of
`.rubrix.dataset.<datset_id>.records-v0`
`.rubrix.dataset.<dataset_id>.records-v0`

## Enable migration process

Expand All @@ -54,10 +54,10 @@ If you want the new Argilla Server to detect previous Rubrix datasets and make t
ARGILLA_ENABLE_MIGRATION=1 argilla server start
```

This will fetch info contained in the Rubrix instance `.rubrix.datasetsw-v0` index and
This will fetch info contained in the Rubrix instance `.rubrix.datasets-v0` index and
will copy the info into the new `ar.datasets` index.

Then, for each old rubrix index, will create an alias with new new name convention format.
Then, for each old rubrix index, will create an alias with new naming convention format.

This will allow you to work with previous Rubrix datasets from your new Argilla Server without duplicating information and still see the changes from your previous Rubrix Server.

Expand Down

0 comments on commit 38c2799

Please sign in to comment.