Skip to content

Commit 90f1ef6

Browse files
docs: 4920 v1 docs add banner with link to the new docs post refactor (#5008)
# 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** (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 **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/)
1 parent f6edbdf commit 90f1ef6

File tree

8 files changed

+56
-33
lines changed

8 files changed

+56
-33
lines changed

argilla/docs/how_to_guides/index.md

Lines changed: 5 additions & 21 deletions
Original file line numberDiff line numberDiff line change
@@ -1,11 +1,11 @@
11
---
2-
description: These are the how-to guides for the the Argilla Python SDK SDK. They provide step-by-step instructions for common scenarios, including detailed explanations and code samples.
2+
description: These are the how-to guides for the Argilla Python SDK. They provide step-by-step instructions for common scenarios, including detailed explanations and code samples.
33
hide: toc
44
---
55

66
# How-to guides
77

8-
These are the how-to guides for the *the Argilla Python SDK SDK*. They provide step-by-step instructions for common scenarios, including detailed explanations and code samples.
8+
These are the how-to guides for *the Argilla Python SDK*. They provide step-by-step instructions for common scenarios, including detailed explanations and code samples.
99

1010
<div class="grid cards" markdown>
1111

@@ -49,28 +49,12 @@ These are the how-to guides for the *the Argilla Python SDK SDK*. They provide s
4949

5050
[:octicons-arrow-right-24: How-to guide](query_export.md)
5151

52-
<!-- - :material-scale-balance:{ .lg .middle } __Distribute annotation work__
52+
- __Migrate to Argilla V2__
5353

5454
---
5555

56-
Learn how to distribute [`Records`](#) to [`Users`](#) and [`Workspaces`](#) for managing annotation efforts the way you require.
56+
Learn how to migrate your legacy datasets from Argilla 1.x to 2.x.
5757

58-
[:octicons-arrow-right-24: License](#)
59-
60-
- :material-scale-balance:{ .lg .middle } __Evaluate annotators and models with metrics and KPIs__
61-
62-
---
63-
64-
Learn how to evaluate [`Users`](#) and Models with [`Metrics`](#) and [`KPIs`](#) to ensure the quality of your data, models and annotations.
65-
66-
[:octicons-arrow-right-24: License](#)
67-
68-
- :material-scale-balance:{ .lg .middle } __Fine-tune a model__
69-
70-
---
71-
72-
Learn how to fine-tune your own model with [`transformers`](#) and take ownership of your data and models.
73-
74-
[:octicons-arrow-right-24: License](#) -->
58+
[:octicons-arrow-right-24: How-to guide](migrate_from_legacy_datasets.md)
7559

7660
</div>
Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
# Migrate your legacy datasets to Argilla V2

argilla/docs/index.md

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -7,6 +7,15 @@ hide: navigation
77

88
Argilla is a **collaboration platform for AI engineers and domain experts** that require **high-quality outputs, full data ownership, and overall efficiency**.
99

10+
!!! SUCCESS "Welcome to Argilla 2.x!"
11+
To skip the introductions and go directly to installing and creating your first dataset, see [Quickstart](getting_started/quickstart/).
12+
13+
!!! DANGER "Looking for Argilla 1.x?"
14+
Looking for documentation for Argilla 1.x? Visit the latest release [here](https://docs.argilla.io/en/latest/).
15+
16+
!!! NOTE "Migrate to Argilla 2.x"
17+
Want to learn how to migrate from Argilla 1.x to 2.x? Take a look at our dedicated [Migration Guide](how_to_guides/migrate_from_legacy_datasets.md).
18+
1019
<div class="grid cards" markdown>
1120

1221
- __Get started in 5 minutes!__

argilla/docs/scripts/gen_changelog.py

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -24,10 +24,12 @@
2424

2525
DATA_PATH = "community/changelog.md"
2626

27-
GITHUB_ACCESS_TOKEN = os.environ["GH_ACCESS_TOKEN"] # public_repo and read:org scopes are required
27+
GITHUB_ACCESS_TOKEN = os.getenv("GH_ACCESS_TOKEN") # public_repo and read:org scopes are required
2828

2929

3030
def fetch_file_from_github(repository, changelog_path, branch, auth_token):
31+
if auth_token is None:
32+
return ""
3133
headers = {"Authorization": f"Bearer {auth_token}", "Accept": "application/vnd.github.v3+json"}
3234

3335
owner, repo_name = repository.split("/")

argilla/docs/scripts/gen_popular_issues.py

Lines changed: 18 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -22,10 +22,27 @@
2222
REPOSITORY = "argilla-io/argilla"
2323
DATA_PATH = "community/popular_issues.md"
2424

25-
GITHUB_ACCESS_TOKEN = os.environ["GH_ACCESS_TOKEN"] # public_repo and read:org scopes are required
25+
GITHUB_ACCESS_TOKEN = os.getenv("GH_ACCESS_TOKEN") # public_repo and read:org scopes are required
2626

2727

2828
def fetch_data_from_github(repository, auth_token):
29+
if auth_token is None:
30+
return pd.DataFrame(
31+
{
32+
"Issue": [],
33+
"State": [],
34+
"Created at": [],
35+
"Closed at": [],
36+
"Last update": [],
37+
"Labels": [],
38+
"Milestone": [],
39+
"Reactions": [],
40+
"Comments": [],
41+
"URL": [],
42+
"Repository": [],
43+
"Author": [],
44+
}
45+
)
2946
headers = {"Authorization": f"token {auth_token}", "Accept": "application/vnd.github.v3+json"}
3047
issues_data = []
3148

argilla/mkdocs.yml

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -140,6 +140,7 @@ nav:
140140
- Manage and create datasets: how_to_guides/dataset.md
141141
- Add, update, and delete records: how_to_guides/record.md
142142
- Query, filter, and export records: how_to_guides/query_export.md
143+
- Migrate your legacy datasets to Argilla V2: how_to_guides/migrate_from_legacy_datasets.md
143144
- API Reference:
144145
- Python SDK: reference/argilla/
145146
- Community:

docs/_source/conf.py

Lines changed: 13 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -39,7 +39,8 @@
3939
version_ = rg.__version__
4040
except ModuleNotFoundError:
4141
version_ = os.environ.get("VERSION")
42-
42+
except AttributeError:
43+
version_ = os.environ.get("VERSION")
4344

4445
project = "Argilla"
4546
copyright = f"{datetime.today().year}, Argilla.io"
@@ -82,9 +83,8 @@
8283
"pipversion": "" if "dev" in release else "==" + release,
8384
"dockertag": "master" if "dev" in release else "v" + release,
8485
}
85-
myst_substitutions[
86-
"dockercomposeyaml"
87-
] = """```yaml
86+
myst_substitutions["dockercomposeyaml"] = (
87+
"""```yaml
8888
# docker-compose.yaml
8989
version: "3"
9090
@@ -98,11 +98,11 @@
9898
ARGILLA_AUTH_SECRET_KEY: Please generate a 32 character random string with: openssl rand -hex 32
9999
restart: unless-stopped
100100
```""".format(
101-
myst_substitutions["dockertag"]
101+
myst_substitutions["dockertag"]
102+
)
102103
)
103-
myst_substitutions[
104-
"dockercomposeuseryaml"
105-
] = """```yaml
104+
myst_substitutions["dockercomposeuseryaml"] = (
105+
"""```yaml
106106
# docker-compose.yaml
107107
services:
108108
argilla:
@@ -119,14 +119,17 @@
119119
- ${}/.users.yaml:/config/.users.yaml
120120
...
121121
```""".format(
122-
myst_substitutions["dockertag"], "PWD"
122+
myst_substitutions["dockertag"], "PWD"
123+
)
123124
)
124125

125126
# Do not execute the notebooks when building the docs
126127
nbsphinx_execute = "never"
127128

128129
# open html file as Python string
129-
getting_started_html = open("./_common/getting_started.html", "r", encoding="utf8").read()
130+
getting_started_html = open(
131+
"./_common/getting_started.html", "r", encoding="utf8"
132+
).read()
130133
next_steps_html = open("./_common/next_steps.html", "r", encoding="utf8").read()
131134

132135
# -- AUTODOC IMPORT MOCKS ---------------------------------------------------

docs/_source/getting_started/argilla.md

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -2,6 +2,12 @@
22

33
[Argilla](https://argilla.io) is an open-source data curation platform for LLMs. Using Argilla, everyone can build robust language models through faster data curation using both human and machine feedback. We provide support for each step in the MLOps cycle, from data labeling to model monitoring.
44

5+
```{admonition} Argilla 2.x
6+
:class: danger
7+
We are announcing that Argilla 1.29 is the final minor release for Argilla 1.x. Although we will continue to release bug fixes for this version, we will neither be adding nor removing any functionalities. Instead, we will focus our efforts on Argilla 2.x. Argilla 1.29 will reach its end-of-life on June 20, 2025.
8+
Looking for documentation for Argilla 2.x? Visit the docs [here](https://argilla-io.github.io/argilla/dev/)!
9+
```
10+
511
<div class="social social--sidebar" style="margin-top: 1em; display: flex; justify-content: right; gap: 8px">
612
<a href="https://join.slack.com/t/rubrixworkspace/shared_invite/zt-whigkyjn-a3IUJLD7gDbTZ0rKlvcJ5g"
713
class="button--primary" target="_blank">Join <span aria-label="slack" class="slack-icon"></span></a>

0 commit comments

Comments
 (0)