Skip to content

Commit

Permalink
[DOCS] Final review for 2.0.0 (#5336)
Browse files Browse the repository at this point in the history
# Description
<!-- 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. -->


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

- Documentation update

**How Has This Been Tested**
<!-- Please add some reference about how your feature has been tested.
-->

**Checklist**
<!-- Please go over the list and make sure you've taken everything into
account -->

- I added relevant documentation
- I followed 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/)

---------

Co-authored-by: dvsrepo <[email protected]>
Co-authored-by: David Berenstein <[email protected]>
Co-authored-by: Leire <[email protected]>
Co-authored-by: sdiazlor <[email protected]>
Co-authored-by: José Francisco Calvo <[email protected]>
Co-authored-by: Sara Han <[email protected]>
Co-authored-by: Daniel Vila Suero <[email protected]>
Co-authored-by: pre-commit-ci[bot] <66853113+pre-commit-ci[bot]@users.noreply.github.com>
  • Loading branch information
9 people authored Jul 30, 2024
1 parent 5c36593 commit ac96f3b
Show file tree
Hide file tree
Showing 76 changed files with 428 additions and 529 deletions.
2 changes: 1 addition & 1 deletion .github/workflows/argilla.docs.yml
Original file line number Diff line number Diff line change
Expand Up @@ -101,4 +101,4 @@ jobs:
if: startsWith(github.ref, 'refs/heads/docs') || startsWith(github.head_ref, 'docs/')
with:
message: |
Docs for this PR have been deployed hidden from versioning: [https://argilla-io.github.io/argilla/${{ steps.extract_branch_name.outputs.branch_name }}](https://argilla-io.github.io/argilla/${{ steps.extract_branch_name.outputs.branch_name }})
Docs for this PR have been deployed hidden from versioning: [https://docs.argilla.io/${{ steps.extract_branch_name.outputs.branch_name }}](https://docs.argilla.io/${{ steps.extract_branch_name.outputs.branch_name }})
2 changes: 1 addition & 1 deletion CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -17,5 +17,5 @@ We understand that getting started might be a bit difficult, therefore, you can

## Want to work on your own?

For more seasoned contributors, we recommend taking a look at the [contributor section](https://docs.argilla.io/en/latest/community/contributing.html) in our docs.
For more seasoned contributors, we recommend taking a look at the [contributor section](https://docs.argilla.io/latest/community/contributor/) in our docs.

6 changes: 3 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -34,7 +34,7 @@

Argilla is a collaboration tool for AI engineers and domain experts who need to build high-quality datasets for their projects.

If you just want to get started, we recommend our [UI demo](https://demo.argilla.io/sign-in?auth=ZGVtbzoxMjM0NTY3OA%3D%3D) or our [free Hugging Face Spaces deployment integration](https://huggingface.co/new-space?template=argilla/argilla-template-space). Curious, and want to know more? Read our [documentation](https://argilla-io.github.io/argilla/latest/).
If you just want to get started, [deploy Argilla on Hugging Face Spaces](https://docs.v2.argilla.io/latest/getting_started/quickstart/). Curious, and want to know more? Read our [documentation](https://docs.v2.argilla.io/latest/).

## Why use Argilla?

Expand Down Expand Up @@ -143,11 +143,11 @@ dataset.records.log(records=data, mapping={"text": "review"})
```

🎉 You have successfully created your first dataset with Argilla. You can now access it in the Argilla UI and start annotating the records.
Need more info, check out [our docs](https://argilla-io.github.io/argilla/latest/).
Need more info, check out [our docs](https://docs.argilla.io/latest/).

## 🥇 Contributors

To help our community with the creation of contributions, we have created our [community](https://argilla-io.github.io/argilla/latest/community/) docs. Additionally, you can always [schedule a meeting](https://calendly.com/david-berenstein-huggingface/30min) with our Developer Advocacy team so they can get you up to speed.
To help our community with the creation of contributions, we have created our [community](https://docs.argilla.io/latest/community/) docs. Additionally, you can always [schedule a meeting](https://calendly.com/david-berenstein-huggingface/30min) with our Developer Advocacy team so they can get you up to speed.

<a href="https://github.com/argilla-io/argilla/graphs/contributors">

Expand Down
7 changes: 4 additions & 3 deletions argilla-frontend/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -32,10 +32,11 @@
</p>

Argilla is a collaboration tool for AI engineers and domain experts who need to build high-quality datasets for their projects.
If you just want to get started, we recommend our [UI demo](https://demo.argilla.io/sign-in?auth=ZGVtbzoxMjM0NTY3OA%3D%3D) or our [free Hugging Face Spaces deployment integration](https://docs.v2.argilla.io/latest/getting_started/huggingface-spaces/). Curious, and want to know more? Read our [documentation](https://argilla-io.github.io/argilla/latest/).

If you just want to get started, deploy Argilla with [Hugging Face Spaces](https://docs.v2.argilla.io/latest/getting_started/quickstart/). Curious, and want to know more? Read our [documentation](https://docs.v2.argilla.io).

This repository only contains developer info about the front end. If you want to get started, we recommend taking a
look at our [main repository](https://github.com/argilla-io/argilla) or our [documentation](https://argilla-io.github.io/argilla/latest/).
look at our [main repository](https://github.com/argilla-io/argilla) or our [documentation](https://docs.argilla.io/latest/).

Are you a contributor or do you want to understand what is going on under the hood, please keep reading the
documentation below.
Expand Down Expand Up @@ -76,7 +77,7 @@ npm run generate

## 🫱🏾‍🫲🏼 Contribute

To help our community with the creation of contributions, we have created our [community](https://argilla-io.github.io/argilla/latest/community/) docs. Additionally, you can always [schedule a meeting](https://calendly.com/david-berenstein-huggingface/30min) with our Developer Advocacy team so they can get you up to speed.
To help our community with the creation of contributions, we have created our [community](https://docs.argilla.io/latest/community/) docs. Additionally, you can always [schedule a meeting](https://calendly.com/david-berenstein-huggingface/30min) with our Developer Advocacy team so they can get you up to speed.

<a href="https://github.com/argilla-io/argilla/graphs/contributors">

Expand Down
8 changes: 4 additions & 4 deletions argilla-frontend/docs/snippets/start_page.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@

# Welcome to

## Argilla is a platform for building high-quality AI datasets
## Argilla is a collaboration tool for building high-quality AI datasets

If you need support join the [Argilla Discord community](http://hf.co/join/discord)

Expand Down Expand Up @@ -36,9 +36,9 @@ client = rg.Argilla(

### 3. Create your first dataset

Specify a workspace where the dataset will be created. Check your workspaces in ["My settings"](/user-settings). To create a new workspace, check the [docs](https://argilla-io.github.io/argilla/latest/how_to_guides/workspace/).
Specify a workspace where the dataset will be created. Check your workspaces in ["My settings"](/user-settings). To create a new workspace, check the [docs](https://docs.argilla.io/latest/how_to_guides/workspace/).

Here, we are defining a creating a dataset with a text field and a label question ("positive" and "negative"), check the docs to [create a fully custom dataset](https://argilla-io.github.io/argilla/latest/how_to_guides/dataset/). Don't forget to replace "<your-workspace>".
Here, we are defining a creating a dataset with a text field and a label question ("positive" and "negative"), check the docs to [create a fully custom dataset](https://docs.argilla.io/latest/how_to_guides/dataset/). Don't forget to replace "<your-workspace>".

```python
settings = rg.Settings(
Expand Down Expand Up @@ -71,7 +71,7 @@ dataset.create()

You can create a list with records that you want to add. Ensure that you match the fields with those specified in the question settings.

You can also use `pandas` or `datasets.load_dataset` to [read an existing dataset and create records from it](https://argilla-io.github.io/argilla/latest/how_to_guides/record/).
You can also use `pandas` or `datasets.load_dataset` to [read an existing dataset and create records from it](https://docs.argilla.io/latest/how_to_guides/record/).

```python
records = [
Expand Down
10 changes: 2 additions & 8 deletions argilla-frontend/nuxt.config.ts
Original file line number Diff line number Diff line change
Expand Up @@ -15,8 +15,8 @@
* limitations under the License.
*/

import { NuxtConfig } from "@nuxt/types";
import Mode from "frontmatter-markdown-loader/mode";
import { NuxtConfig } from "@nuxt/types";
import pkg from "./package.json";

const LOCAL_ENVIRONMENT = "http://0.0.0.0:6900";
Expand Down Expand Up @@ -204,14 +204,8 @@ const config: NuxtConfig = {
publicRuntimeConfig: {
clientVersion: pkg.version,
documentationSite: "https://docs.argilla.io/",
documentationSiteSemanticSearch:
"https://docs.argilla.io/en/latest/reference/webapp/features.html#semantic-search",
documentationSiteLabelScheme:
"https://docs.argilla.io/en/latest/guides/log_load_and_prepare_data.html#define-a-labeling-schema",
documentationSiteQueryDatasets:
"https://docs.argilla.io/en/latest/guides/query_datasets.html",
documentationPersistentStorage:
"https://docs.argilla.io/en/latest/getting_started/installation/deployments/huggingface-spaces.html#setting-up-persistent-storage",
"https://docs.argilla.io/latest/getting_started/how-to-configure-argilla-on-huggingface/#persistent-storage",
},
};
export default config;
8 changes: 4 additions & 4 deletions argilla-server/CHANGELOG.md
Original file line number Diff line number Diff line change
Expand Up @@ -152,7 +152,7 @@ These are the section headers that we use:

> [!IMPORTANT]
> This version include changes related to the search index. So, a reindex is needed.
> Visit the [docs](https://docs.argilla.io/en/latest/getting_started/installation/configurations/database_migrations.html#feedback-datasets) for more info.
> Visit the [docs](https://docs.v1.argilla.io/en/latest/getting_started/installation/configurations/database_migrations.html#feedback-datasets) for more info.
### Added

Expand All @@ -163,8 +163,8 @@ These are the section headers that we use:

### Changed

- Changed indexing responses for search to use user `id` instead of `username`. **[Reindex needed](https://docs.argilla.io/en/latest/getting_started/installation/configurations/database_migrations.html#feedback-datasets)** ([#26](https://github.com/argilla-io/argilla-server/pull/26))
- Changed search index mappings definition to optimize the number of fields. **[Reindex needed](https://docs.argilla.io/en/latest/getting_started/installation/configurations/database_migrations.html#feedback-datasets)** ([#31](https://github.com/argilla-io/argilla-server/pull/31))
- Changed indexing responses for search to use user `id` instead of `username`. **[Reindex needed](https://docs.v1.argilla.io/en/latest/getting_started/installation/configurations/database_migrations.html#feedback-datasets)** ([#26](https://github.com/argilla-io/argilla-server/pull/26))
- Changed search index mappings definition to optimize the number of fields. **[Reindex needed](https://docs.v1.argilla.io/en/latest/getting_started/installation/configurations/database_migrations.html#feedback-datasets)** ([#31](https://github.com/argilla-io/argilla-server/pull/31))

### Removed

Expand Down Expand Up @@ -651,7 +651,7 @@ These are the section headers that we use:
- Added Telemetry support for `ArgillaTrainer` (closes [#3325](https://github.com/argilla-io/argilla/issues/3325))
- `User.workspaces` is no longer an attribute but a property, and is calling `list_user_workspaces` to list all the workspace names for a given user ID ([#3334](https://github.com/argilla-io/argilla/pull/3334))
- Renamed `FeedbackDatasetConfig` to `DatasetConfig` and export/import from YAML as default instead of JSON (just used internally on `push_to_huggingface` and `from_huggingface` methods of `FeedbackDataset`) ([#3326](https://github.com/argilla-io/argilla/pull/3326)).
- The protected metadata fields support other than textual info - existing datasets must be reindex. See [docs](https://docs.argilla.io/en/latest/getting_started/installation/configurations/database_migrations.html#elasticsearch) for more detail (Closes [#3332](https://github.com/argilla-io/argilla/issues/3332)).
- The protected metadata fields support other than textual info - existing datasets must be reindex. See [docs](https://docs.v1.argilla.io/en/latest/getting_started/installation/configurations/database_migrations.html#elasticsearch) for more detail (Closes [#3332](https://github.com/argilla-io/argilla/issues/3332)).
- Updated `Dockerfile` parent image from `python:3.9.16-slim` to `python:3.10.12-slim` ([#3425](https://github.com/argilla-io/argilla/pull/3425)).
- Updated `quickstart.Dockerfile` parent image from `elasticsearch:8.5.3` to `argilla/argilla-server:${ARGILLA_VERSION}` ([#3425](https://github.com/argilla-io/argilla/pull/3425)).

Expand Down
4 changes: 2 additions & 2 deletions argilla-server/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -34,7 +34,7 @@
Argilla is a collaboration tool for AI engineers and domain experts who need to build high-quality datasets for their projects.

This repository only contains developer info about the backend server. If you want to get started, we recommend taking a
look at our [main repository](https://github.com/argilla-io/argilla) or our [documentation](https://argilla-io.github.io/argilla/latest/).
look at our [main repository](https://github.com/argilla-io/argilla) or our [documentation](https://docs.argilla.io/latest/).

Are you a contributor or do you want to understand what is going on under the hood, please keep reading the
documentation below.
Expand Down Expand Up @@ -273,7 +273,7 @@ The `argilla_server search-engine` group of commands offers functionality to wor

## 🫱🏾‍🫲🏼 Contribute

To help our community with the creation of contributions, we have created our [community](https://argilla-io.github.io/argilla/latest/community/) docs. Additionally, you can always [schedule a meeting](https://calendly.com/david-berenstein-huggingface/30min) with our Developer Advocacy team so they can get you up to speed.
To help our community with the creation of contributions, we have created our [community](https://docs.argilla.io/latest/community/) docs. Additionally, you can always [schedule a meeting](https://calendly.com/david-berenstein-huggingface/30min) with our Developer Advocacy team so they can get you up to speed.

<a href="https://github.com/argilla-io/argilla/graphs/contributors">

Expand Down
2 changes: 1 addition & 1 deletion argilla-server/docker/argilla-hf-spaces/Dockerfile
Original file line number Diff line number Diff line change
Expand Up @@ -28,7 +28,7 @@ RUN \
apt-get update && apt-get install -y elasticsearch=8.8.2 && \
chown -R argilla:argilla /usr/share/elasticsearch /etc/elasticsearch /var/lib/elasticsearch /var/log/elasticsearch && \
chown argilla:argilla /etc/default/elasticsearch && \
# Install quickstart image dependencies
# Install image dependencies
pip install -r /packages/requirements.txt && \
chmod +x /home/argilla/start.sh && \
chmod +x /home/argilla/start_argilla_server.sh && \
Expand Down
2 changes: 1 addition & 1 deletion argilla-server/src/argilla_server/_app.py
Original file line number Diff line number Diff line change
Expand Up @@ -171,7 +171,7 @@ def show_telemetry_warning():
message += inspect.cleandoc(

Check warning on line 171 in argilla-server/src/argilla_server/_app.py

View check run for this annotation

Codecov / codecov/patch

argilla-server/src/argilla_server/_app.py#L169-L171

Added lines #L169 - L171 were not covered by tests
"Argilla uses telemetry to report anonymous usage and error information. You\n"
"can know more about what information is reported at:\n\n"
" https://docs.argilla.io/en/latest/reference/telemetry.html\n\n"
" https://docs.argilla.io/latest/reference/argilla-server/telemetry/\n\n"
"Telemetry is currently enabled. If you want to disable it, you can configure\n"
"the environment variable before relaunching the server:\n\n"
f'{"#set ARGILLA_ENABLE_TELEMETRY=0" if os.name == "nt" else "$>export ARGILLA_ENABLE_TELEMETRY=0"}'
Expand Down
2 changes: 1 addition & 1 deletion argilla-v1/CHANGELOG.md
Original file line number Diff line number Diff line change
Expand Up @@ -601,7 +601,7 @@ These are the section headers that we use:
- Added Telemetry support for `ArgillaTrainer` (closes [#3325](https://github.com/argilla-io/argilla/issues/3325))
- `User.workspaces` is no longer an attribute but a property, and is calling `list_user_workspaces` to list all the workspace names for a given user ID ([#3334](https://github.com/argilla-io/argilla/pull/3334))
- Renamed `FeedbackDatasetConfig` to `DatasetConfig` and export/import from YAML as default instead of JSON (just used internally on `push_to_huggingface` and `from_huggingface` methods of `FeedbackDataset`) ([#3326](https://github.com/argilla-io/argilla/pull/3326)).
- The protected metadata fields support other than textual info - existing datasets must be reindex. See [docs](https://docs.argilla.io/en/latest/getting_started/installation/configurations/database_migrations.html#elasticsearch) for more detail (Closes [#3332](https://github.com/argilla-io/argilla/issues/3332)).
- The protected metadata fields support other than textual info - existing datasets must be reindex. See [docs](https://docs.v1.argilla.io/en/latest/getting_started/installation/configurations/database_migrations.html#elasticsearch) for more detail (Closes [#3332](https://github.com/argilla-io/argilla/issues/3332)).
- Updated `Dockerfile` parent image from `python:3.9.16-slim` to `python:3.10.12-slim` ([#3425](https://github.com/argilla-io/argilla/pull/3425)).
- Updated `quickstart.Dockerfile` parent image from `elasticsearch:8.5.3` to `argilla/argilla-server:${ARGILLA_VERSION}` ([#3425](https://github.com/argilla-io/argilla/pull/3425)).

Expand Down
Loading

0 comments on commit ac96f3b

Please sign in to comment.