Skip to content
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 2 additions & 0 deletions .github/workflows/validate-sync.yml
Original file line number Diff line number Diff line change
Expand Up @@ -21,3 +21,5 @@ jobs:
run: |
python -m py_compile scripts/sync_from_platformbackend.py tests/test_sync_from_platformbackend.py
python tests/test_sync_from_platformbackend.py
python tests/test_quickstart_acquisition.py
python scripts/check_quickstart_acquisition.py
4 changes: 2 additions & 2 deletions ar/quickstart.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -5,11 +5,11 @@ description: "البدء مع Ace Data Cloud API في 5 دقائق"

## 1. الحصول على مفتاح API

قم بالتسجيل في [platform.acedata.cloud](https://platform.acedata.cloud) وأنشئ بيانات اعتماد API.
قم بالتسجيل في [platform.acedata.cloud](https://platform.acedata.cloud/?utm_source=docs&utm_medium=quickstart&utm_campaign=docs-quickstart) وأنشئ بيانات اعتماد API.

<Steps>
<Step title="التسجيل">
قم بزيارة [platform.acedata.cloud](https://platform.acedata.cloud) وأكمل عملية التسجيل.
قم بزيارة [platform.acedata.cloud](https://platform.acedata.cloud/?utm_source=docs&utm_medium=quickstart&utm_campaign=docs-quickstart) وأكمل عملية التسجيل.
</Step>
<Step title="الاشتراك في الخدمة">
تصفح الخدمات المتاحة، وانقر على **الحصول** لإكمال الاشتراك. معظم الخدمات توفر حصة مجانية.
Expand Down
4 changes: 2 additions & 2 deletions de/quickstart.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -5,11 +5,11 @@ description: "In 5 Minuten mit der Ace Data Cloud API starten"

## 1. API-Schlüssel erhalten

Registrieren Sie sich auf [platform.acedata.cloud](https://platform.acedata.cloud) und erstellen Sie API-Anmeldeinformationen.
Registrieren Sie sich auf [platform.acedata.cloud](https://platform.acedata.cloud/?utm_source=docs&utm_medium=quickstart&utm_campaign=docs-quickstart) und erstellen Sie API-Anmeldeinformationen.

<Steps>
<Step title="Konto registrieren">
Besuchen Sie [platform.acedata.cloud](https://platform.acedata.cloud) und schließen Sie die Registrierung ab.
Besuchen Sie [platform.acedata.cloud](https://platform.acedata.cloud/?utm_source=docs&utm_medium=quickstart&utm_campaign=docs-quickstart) und schließen Sie die Registrierung ab.
</Step>
<Step title="Dienst abonnieren">
Durchsuchen Sie die verfügbaren Dienste und klicken Sie auf **Erhalten**, um ein Abonnement abzuschließen. Die meisten Dienste bieten ein kostenloses Kontingent.
Expand Down
4 changes: 2 additions & 2 deletions el/quickstart.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -5,11 +5,11 @@ description: "Ξεκινήστε με το Ace Data Cloud API σε 5 λεπτά"

## 1. Απόκτηση API Key

Εγγραφείτε στο [platform.acedata.cloud](https://platform.acedata.cloud) και δημιουργήστε τα διαπιστευτήρια API.
Εγγραφείτε στο [platform.acedata.cloud](https://platform.acedata.cloud/?utm_source=docs&utm_medium=quickstart&utm_campaign=docs-quickstart) και δημιουργήστε τα διαπιστευτήρια API.

<Steps>
<Step title="Εγγραφή Λογαριασμού">
Επισκεφθείτε το [platform.acedata.cloud](https://platform.acedata.cloud) για να ολοκληρώσετε την εγγραφή.
Επισκεφθείτε το [platform.acedata.cloud](https://platform.acedata.cloud/?utm_source=docs&utm_medium=quickstart&utm_campaign=docs-quickstart) για να ολοκληρώσετε την εγγραφή.
</Step>
<Step title="Εγγραφή Υπηρεσίας">
Περιηγηθείτε στις διαθέσιμες υπηρεσίες και κάντε κλικ στο **Λήψη** για να ολοκληρώσετε την εγγραφή. Οι περισσότερες υπηρεσίες προσφέρουν δωρεάν όρια.
Expand Down
2 changes: 1 addition & 1 deletion en/quickstart.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@ This walkthrough uses **Midjourney text-to-image** as the example: sign up → g

## 1. Sign up and grab credit

1. Register at [platform.acedata.cloud](https://platform.acedata.cloud)
1. Register at [platform.acedata.cloud](https://platform.acedata.cloud/?utm_source=docs&utm_medium=quickstart&utm_campaign=docs-quickstart)
2. Open the **Midjourney** service detail page and purchase a package or claim a trial
3. On the **Credentials** tab, click **Create** and copy the returned Token

Expand Down
4 changes: 2 additions & 2 deletions es/quickstart.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -5,11 +5,11 @@ description: "Comience con la API de Ace Data Cloud en 5 minutos"

## 1. Obtener la clave API

Regístrese en [platform.acedata.cloud](https://platform.acedata.cloud) y cree sus credenciales API.
Regístrese en [platform.acedata.cloud](https://platform.acedata.cloud/?utm_source=docs&utm_medium=quickstart&utm_campaign=docs-quickstart) y cree sus credenciales API.

<Steps>
<Step title="Registrarse">
Visite [platform.acedata.cloud](https://platform.acedata.cloud) para completar el registro.
Visite [platform.acedata.cloud](https://platform.acedata.cloud/?utm_source=docs&utm_medium=quickstart&utm_campaign=docs-quickstart) para completar el registro.
</Step>
<Step title="Suscribirse al servicio">
Explore los servicios disponibles y haga clic en **Obtener** para suscribirse. La mayoría de los servicios ofrecen un nivel gratuito.
Expand Down
4 changes: 2 additions & 2 deletions fi/quickstart.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -5,11 +5,11 @@ description: "Aloita Ace Data Cloud API:n käyttö 5 minuutissa"

## 1. Hanki API-avain

Rekisteröidy tilille osoitteessa [platform.acedata.cloud](https://platform.acedata.cloud) ja luo API-todennustiedot.
Rekisteröidy tilille osoitteessa [platform.acedata.cloud](https://platform.acedata.cloud/?utm_source=docs&utm_medium=quickstart&utm_campaign=docs-quickstart) ja luo API-todennustiedot.

<Steps>
<Step title="Rekisteröidy tilille">
Käy osoitteessa [platform.acedata.cloud](https://platform.acedata.cloud) ja suorita rekisteröityminen.
Käy osoitteessa [platform.acedata.cloud](https://platform.acedata.cloud/?utm_source=docs&utm_medium=quickstart&utm_campaign=docs-quickstart) ja suorita rekisteröityminen.
</Step>
<Step title="Tilaa palvelu">
Selaa saatavilla olevia palveluita ja klikkaa **Hanki** tilauksen tekemiseksi. Useimmat palvelut tarjoavat ilmaisen käyttörajan.
Expand Down
4 changes: 2 additions & 2 deletions fr/quickstart.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -5,11 +5,11 @@ description: "Prise en main de l'API Ace Data Cloud en 5 minutes"

## 1. Obtenir une clé API

Inscrivez-vous sur [platform.acedata.cloud](https://platform.acedata.cloud) et créez vos identifiants API.
Inscrivez-vous sur [platform.acedata.cloud](https://platform.acedata.cloud/?utm_source=docs&utm_medium=quickstart&utm_campaign=docs-quickstart) et créez vos identifiants API.

<Steps>
<Step title="Créer un compte">
Rendez-vous sur [platform.acedata.cloud](https://platform.acedata.cloud) pour vous inscrire.
Rendez-vous sur [platform.acedata.cloud](https://platform.acedata.cloud/?utm_source=docs&utm_medium=quickstart&utm_campaign=docs-quickstart) pour vous inscrire.
</Step>
<Step title="S'abonner au service">
Parcourez les services disponibles et cliquez sur **Obtenir** pour vous abonner. La plupart des services offrent un quota gratuit.
Expand Down
4 changes: 2 additions & 2 deletions it/quickstart.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -5,11 +5,11 @@ description: "Inizia con Ace Data Cloud API in 5 minuti"

## 1. Ottenere la API Key

Registrati su [platform.acedata.cloud](https://platform.acedata.cloud) e crea le credenziali API.
Registrati su [platform.acedata.cloud](https://platform.acedata.cloud/?utm_source=docs&utm_medium=quickstart&utm_campaign=docs-quickstart) e crea le credenziali API.

<Steps>
<Step title="Registrazione">
Visita [platform.acedata.cloud](https://platform.acedata.cloud) per completare la registrazione.
Visita [platform.acedata.cloud](https://platform.acedata.cloud/?utm_source=docs&utm_medium=quickstart&utm_campaign=docs-quickstart) per completare la registrazione.
</Step>
<Step title="Abbonamento al servizio">
Esplora i servizi disponibili e clicca su **Ottieni** per completare l'abbonamento. La maggior parte dei servizi offre un piano gratuito.
Expand Down
4 changes: 2 additions & 2 deletions ja/quickstart.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -5,11 +5,11 @@ description: "5分で始めるAce Data Cloud API"

## 1. APIキーの取得

[platform.acedata.cloud](https://platform.acedata.cloud)でアカウントを登録し、API認証情報を作成します。
[platform.acedata.cloud](https://platform.acedata.cloud/?utm_source=docs&utm_medium=quickstart&utm_campaign=docs-quickstart)でアカウントを登録し、API認証情報を作成します。

<Steps>
<Step title="アカウント登録">
[platform.acedata.cloud](https://platform.acedata.cloud)にアクセスして登録を完了してください。
[platform.acedata.cloud](https://platform.acedata.cloud/?utm_source=docs&utm_medium=quickstart&utm_campaign=docs-quickstart)にアクセスして登録を完了してください。
</Step>
<Step title="サービスの購読">
利用可能なサービスを閲覧し、**取得**をクリックして購読を完了します。ほとんどのサービスは無料枠を提供しています。
Expand Down
4 changes: 2 additions & 2 deletions ko/quickstart.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -5,11 +5,11 @@ description: "5분 만에 시작하는 Ace Data Cloud API"

## 1. API 키 받기

[platform.acedata.cloud](https://platform.acedata.cloud)에서 계정을 등록하고 API 자격 증명을 생성하세요.
[platform.acedata.cloud](https://platform.acedata.cloud/?utm_source=docs&utm_medium=quickstart&utm_campaign=docs-quickstart)에서 계정을 등록하고 API 자격 증명을 생성하세요.

<Steps>
<Step title="계정 등록">
[platform.acedata.cloud](https://platform.acedata.cloud)에 접속하여 등록을 완료하세요.
[platform.acedata.cloud](https://platform.acedata.cloud/?utm_source=docs&utm_medium=quickstart&utm_campaign=docs-quickstart)에 접속하여 등록을 완료하세요.
</Step>
<Step title="서비스 구독">
사용 가능한 서비스를 둘러보고 **받기**를 클릭하여 구독을 완료하세요. 대부분의 서비스는 무료 한도를 제공합니다.
Expand Down
4 changes: 2 additions & 2 deletions pl/quickstart.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -5,11 +5,11 @@ description: "5 minut, aby rozpocząć pracę z Ace Data Cloud API"

## 1. Uzyskaj klucz API

Zarejestruj konto i utwórz poświadczenia API na [platform.acedata.cloud](https://platform.acedata.cloud).
Zarejestruj konto i utwórz poświadczenia API na [platform.acedata.cloud](https://platform.acedata.cloud/?utm_source=docs&utm_medium=quickstart&utm_campaign=docs-quickstart).

<Steps>
<Step title="Zarejestruj konto">
Odwiedź [platform.acedata.cloud](https://platform.acedata.cloud) i zakończ rejestrację.
Odwiedź [platform.acedata.cloud](https://platform.acedata.cloud/?utm_source=docs&utm_medium=quickstart&utm_campaign=docs-quickstart) i zakończ rejestrację.
</Step>
<Step title="Subskrybuj usługę">
Przeglądaj dostępne usługi i kliknij **Uzyskaj**, aby subskrybować. Większość usług oferuje darmowy limit.
Expand Down
4 changes: 2 additions & 2 deletions pt/quickstart.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -5,11 +5,11 @@ description: "Comece com a API Ace Data Cloud em 5 minutos"

## 1. Obtenha a Chave da API

Registre uma conta em [platform.acedata.cloud](https://platform.acedata.cloud) e crie suas credenciais de API.
Registre uma conta em [platform.acedata.cloud](https://platform.acedata.cloud/?utm_source=docs&utm_medium=quickstart&utm_campaign=docs-quickstart) e crie suas credenciais de API.

<Steps>
<Step title="Registrar Conta">
Acesse [platform.acedata.cloud](https://platform.acedata.cloud) para completar o registro.
Acesse [platform.acedata.cloud](https://platform.acedata.cloud/?utm_source=docs&utm_medium=quickstart&utm_campaign=docs-quickstart) para completar o registro.
</Step>
<Step title="Assinar Serviço">
Navegue pelos serviços disponíveis e clique em **Obter** para assinar. A maioria dos serviços oferece uma cota gratuita.
Expand Down
4 changes: 2 additions & 2 deletions ru/quickstart.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -5,11 +5,11 @@ description: "Начало работы с Ace Data Cloud API за 5 минут"

## 1. Получение API Key

Зарегистрируйтесь и создайте API-учетные данные на [platform.acedata.cloud](https://platform.acedata.cloud).
Зарегистрируйтесь и создайте API-учетные данные на [platform.acedata.cloud](https://platform.acedata.cloud/?utm_source=docs&utm_medium=quickstart&utm_campaign=docs-quickstart).

<Steps>
<Step title="Регистрация аккаунта">
Перейдите на [platform.acedata.cloud](https://platform.acedata.cloud) и завершите регистрацию.
Перейдите на [platform.acedata.cloud](https://platform.acedata.cloud/?utm_source=docs&utm_medium=quickstart&utm_campaign=docs-quickstart) и завершите регистрацию.
</Step>
<Step title="Подписка на сервис">
Просмотрите доступные сервисы и нажмите **Получить** для подписки. Большинство сервисов предоставляют бесплатный лимит.
Expand Down
58 changes: 58 additions & 0 deletions scripts/check_quickstart_acquisition.py
Original file line number Diff line number Diff line change
@@ -0,0 +1,58 @@
#!/usr/bin/env python3
from __future__ import annotations

import json
import re
import sys
from pathlib import Path


ROOT = Path(__file__).resolve().parents[1]
ACQUISITION_URL = (
"https://platform.acedata.cloud/"
"?utm_source=docs&utm_medium=quickstart&utm_campaign=docs-quickstart"
)
PLATFORM_ROOT_LINK = re.compile(r"https://platform\.acedata\.cloud(?:/\?[^)\s]*)?\)")


def quickstart_navigation_paths(node: object) -> set[str]:
found: set[str] = set()
if isinstance(node, dict):
for value in node.values():
found.update(quickstart_navigation_paths(value))
elif isinstance(node, list):
for value in node:
found.update(quickstart_navigation_paths(value))
elif isinstance(node, str) and node.endswith("/quickstart"):
found.add(node)
return found


def main() -> int:
errors: list[str] = []
files = sorted(ROOT.glob("*/quickstart.mdx"))
if not files:
errors.append("no localized quickstart pages found")
for path in files:
text = path.read_text()
root_links = PLATFORM_ROOT_LINK.findall(text)
if not root_links:
errors.append(f"{path.relative_to(ROOT)}: no platform signup link")
continue
expected = f"{ACQUISITION_URL})"
if any(link != expected for link in root_links):
errors.append(f"{path.relative_to(ROOT)}: contains an unattributed platform root link")
navigation = json.loads((ROOT / "docs.json").read_text())
for page in sorted(quickstart_navigation_paths(navigation)):
if not (ROOT / f"{page}.mdx").exists():
errors.append(f"docs.json: missing navigated page {page}.mdx")
if errors:
for error in errors:
print(error, file=sys.stderr)
return 1
print(f"Quickstart acquisition links cover {len(files)} localized pages")
return 0


if __name__ == "__main__":
raise SystemExit(main())
4 changes: 2 additions & 2 deletions sr/quickstart.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -5,11 +5,11 @@ description: "Pokretanje sa Ace Data Cloud API-jem za 5 minuta"

## 1. Nabavite API ključ

Registrujte nalog na [platform.acedata.cloud](https://platform.acedata.cloud) i kreirajte API akreditive.
Registrujte nalog na [platform.acedata.cloud](https://platform.acedata.cloud/?utm_source=docs&utm_medium=quickstart&utm_campaign=docs-quickstart) i kreirajte API akreditive.

<Steps>
<Step title="Registracija naloga">
Posetite [platform.acedata.cloud](https://platform.acedata.cloud) i završite registraciju.
Posetite [platform.acedata.cloud](https://platform.acedata.cloud/?utm_source=docs&utm_medium=quickstart&utm_campaign=docs-quickstart) i završite registraciju.
</Step>
<Step title="Pretplata na usluge">
Pregledajte dostupne usluge i kliknite na **Preuzmi** da biste se pretplatili. Većina usluga nudi besplatan kvotu.
Expand Down
4 changes: 2 additions & 2 deletions sv/quickstart.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -5,11 +5,11 @@ description: "Kom igång med Ace Data Cloud API på 5 minuter"

## 1. Skaffa API-nyckel

Registrera ett konto och skapa API-uppgifter på [platform.acedata.cloud](https://platform.acedata.cloud).
Registrera ett konto och skapa API-uppgifter på [platform.acedata.cloud](https://platform.acedata.cloud/?utm_source=docs&utm_medium=quickstart&utm_campaign=docs-quickstart).

<Steps>
<Step title="Registrera konto">
Besök [platform.acedata.cloud](https://platform.acedata.cloud) för att slutföra registreringen.
Besök [platform.acedata.cloud](https://platform.acedata.cloud/?utm_source=docs&utm_medium=quickstart&utm_campaign=docs-quickstart) för att slutföra registreringen.
</Step>
<Step title="Prenumerera på tjänst">
Bläddra bland tillgängliga tjänster och klicka på **Få** för att prenumerera. De flesta tjänster erbjuder gratis kvoter.
Expand Down
36 changes: 36 additions & 0 deletions tests/test_quickstart_acquisition.py
Original file line number Diff line number Diff line change
@@ -0,0 +1,36 @@
from __future__ import annotations

import sys
import unittest
from pathlib import Path


SCRIPTS = Path(__file__).resolve().parents[1] / "scripts"
sys.path.insert(0, str(SCRIPTS))

from check_quickstart_acquisition import ( # noqa: E402
ACQUISITION_URL,
main,
quickstart_navigation_paths,
)


class QuickstartAcquisitionTest(unittest.TestCase):
def test_campaign_is_stable(self) -> None:
self.assertEqual(
ACQUISITION_URL,
"https://platform.acedata.cloud/?utm_source=docs&utm_medium=quickstart&utm_campaign=docs-quickstart",
)

def test_navigation_path_extraction(self) -> None:
self.assertEqual(
quickstart_navigation_paths({"pages": ["en/quickstart", "en/introduction"]}),
{"en/quickstart"},
)

def test_repository_quickstarts_are_attributed(self) -> None:
self.assertEqual(main(), 0)


if __name__ == "__main__":
unittest.main()
4 changes: 2 additions & 2 deletions uk/quickstart.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -5,11 +5,11 @@ description: "Початок роботи з Ace Data Cloud API за 5 хвил

## 1. Отримання API Key

Зареєструйте обліковий запис на [platform.acedata.cloud](https://platform.acedata.cloud) та створіть API-ключ.
Зареєструйте обліковий запис на [platform.acedata.cloud](https://platform.acedata.cloud/?utm_source=docs&utm_medium=quickstart&utm_campaign=docs-quickstart) та створіть API-ключ.

<Steps>
<Step title="Реєстрація облікового запису">
Перейдіть на [platform.acedata.cloud](https://platform.acedata.cloud) та завершіть реєстрацію.
Перейдіть на [platform.acedata.cloud](https://platform.acedata.cloud/?utm_source=docs&utm_medium=quickstart&utm_campaign=docs-quickstart) та завершіть реєстрацію.
</Step>
<Step title="Підписка на сервіс">
Перегляньте доступні сервіси, натисніть **Отримати** для підписки. Більшість сервісів надають безкоштовний ліміт.
Expand Down
2 changes: 1 addition & 1 deletion zh-Hans/quickstart.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@ description: "5 分钟跑通你的第一个 Ace Data Cloud API 请求。"

## 1. 注册账号并领取额度

1. 打开 [platform.acedata.cloud](https://platform.acedata.cloud) 注册
1. 打开 [platform.acedata.cloud](https://platform.acedata.cloud/?utm_source=docs&utm_medium=quickstart&utm_campaign=docs-quickstart) 注册
2. 进入「Midjourney」服务详情页,购买套餐或领取试用额度
3. 在「凭证」标签里点击「创建凭证」,复制返回的 Token

Expand Down
4 changes: 2 additions & 2 deletions zh-Hant/quickstart.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -5,11 +5,11 @@ description: "5 分鐘上手 Ace Data Cloud API"

## 1. 獲取 API Key

在 [platform.acedata.cloud](https://platform.acedata.cloud) 註冊帳號並創建 API 憑證。
在 [platform.acedata.cloud](https://platform.acedata.cloud/?utm_source=docs&utm_medium=quickstart&utm_campaign=docs-quickstart) 註冊帳號並創建 API 憑證。

<Steps>
<Step title="註冊帳號">
訪問 [platform.acedata.cloud](https://platform.acedata.cloud) 完成註冊。
訪問 [platform.acedata.cloud](https://platform.acedata.cloud/?utm_source=docs&utm_medium=quickstart&utm_campaign=docs-quickstart) 完成註冊。
</Step>
<Step title="訂閱服務">
瀏覽可用服務,點擊**獲取**完成訂閱。大部分服務提供免費額度。
Expand Down
Loading