diff --git a/.github/workflows/validate-sync.yml b/.github/workflows/validate-sync.yml index 8e01d005..e1efe4a5 100644 --- a/.github/workflows/validate-sync.yml +++ b/.github/workflows/validate-sync.yml @@ -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 diff --git a/ar/quickstart.mdx b/ar/quickstart.mdx index 198b2802..38de2243 100644 --- a/ar/quickstart.mdx +++ b/ar/quickstart.mdx @@ -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. - قم بزيارة [platform.acedata.cloud](https://platform.acedata.cloud) وأكمل عملية التسجيل. + قم بزيارة [platform.acedata.cloud](https://platform.acedata.cloud/?utm_source=docs&utm_medium=quickstart&utm_campaign=docs-quickstart) وأكمل عملية التسجيل. تصفح الخدمات المتاحة، وانقر على **الحصول** لإكمال الاشتراك. معظم الخدمات توفر حصة مجانية. diff --git a/de/quickstart.mdx b/de/quickstart.mdx index 11e9b6de..bece23e3 100644 --- a/de/quickstart.mdx +++ b/de/quickstart.mdx @@ -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. - 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. Durchsuchen Sie die verfügbaren Dienste und klicken Sie auf **Erhalten**, um ein Abonnement abzuschließen. Die meisten Dienste bieten ein kostenloses Kontingent. diff --git a/el/quickstart.mdx b/el/quickstart.mdx index e8172cf0..1063299c 100644 --- a/el/quickstart.mdx +++ b/el/quickstart.mdx @@ -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. - Επισκεφθείτε το [platform.acedata.cloud](https://platform.acedata.cloud) για να ολοκληρώσετε την εγγραφή. + Επισκεφθείτε το [platform.acedata.cloud](https://platform.acedata.cloud/?utm_source=docs&utm_medium=quickstart&utm_campaign=docs-quickstart) για να ολοκληρώσετε την εγγραφή. Περιηγηθείτε στις διαθέσιμες υπηρεσίες και κάντε κλικ στο **Λήψη** για να ολοκληρώσετε την εγγραφή. Οι περισσότερες υπηρεσίες προσφέρουν δωρεάν όρια. diff --git a/en/quickstart.mdx b/en/quickstart.mdx index 9cf77c4e..d3cce4a5 100644 --- a/en/quickstart.mdx +++ b/en/quickstart.mdx @@ -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 diff --git a/es/quickstart.mdx b/es/quickstart.mdx index 35e9929b..118e392c 100644 --- a/es/quickstart.mdx +++ b/es/quickstart.mdx @@ -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. - 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. Explore los servicios disponibles y haga clic en **Obtener** para suscribirse. La mayoría de los servicios ofrecen un nivel gratuito. diff --git a/fi/quickstart.mdx b/fi/quickstart.mdx index 029266cf..39557d70 100644 --- a/fi/quickstart.mdx +++ b/fi/quickstart.mdx @@ -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. - 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. Selaa saatavilla olevia palveluita ja klikkaa **Hanki** tilauksen tekemiseksi. Useimmat palvelut tarjoavat ilmaisen käyttörajan. diff --git a/fr/quickstart.mdx b/fr/quickstart.mdx index 316664c4..d5924060 100644 --- a/fr/quickstart.mdx +++ b/fr/quickstart.mdx @@ -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. - 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. Parcourez les services disponibles et cliquez sur **Obtenir** pour vous abonner. La plupart des services offrent un quota gratuit. diff --git a/it/quickstart.mdx b/it/quickstart.mdx index 64db8abb..6271358a 100644 --- a/it/quickstart.mdx +++ b/it/quickstart.mdx @@ -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. - 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. Esplora i servizi disponibili e clicca su **Ottieni** per completare l'abbonamento. La maggior parte dei servizi offre un piano gratuito. diff --git a/ja/quickstart.mdx b/ja/quickstart.mdx index 124fa8ab..8c678c2e 100644 --- a/ja/quickstart.mdx +++ b/ja/quickstart.mdx @@ -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認証情報を作成します。 - [platform.acedata.cloud](https://platform.acedata.cloud)にアクセスして登録を完了してください。 + [platform.acedata.cloud](https://platform.acedata.cloud/?utm_source=docs&utm_medium=quickstart&utm_campaign=docs-quickstart)にアクセスして登録を完了してください。 利用可能なサービスを閲覧し、**取得**をクリックして購読を完了します。ほとんどのサービスは無料枠を提供しています。 diff --git a/ko/quickstart.mdx b/ko/quickstart.mdx index 3e166981..a76bdc41 100644 --- a/ko/quickstart.mdx +++ b/ko/quickstart.mdx @@ -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 자격 증명을 생성하세요. - [platform.acedata.cloud](https://platform.acedata.cloud)에 접속하여 등록을 완료하세요. + [platform.acedata.cloud](https://platform.acedata.cloud/?utm_source=docs&utm_medium=quickstart&utm_campaign=docs-quickstart)에 접속하여 등록을 완료하세요. 사용 가능한 서비스를 둘러보고 **받기**를 클릭하여 구독을 완료하세요. 대부분의 서비스는 무료 한도를 제공합니다. diff --git a/pl/quickstart.mdx b/pl/quickstart.mdx index dfb1ebd0..90c9f1d7 100644 --- a/pl/quickstart.mdx +++ b/pl/quickstart.mdx @@ -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). - 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ę. Przeglądaj dostępne usługi i kliknij **Uzyskaj**, aby subskrybować. Większość usług oferuje darmowy limit. diff --git a/pt/quickstart.mdx b/pt/quickstart.mdx index 95f9cc45..420bc1ad 100644 --- a/pt/quickstart.mdx +++ b/pt/quickstart.mdx @@ -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. - 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. Navegue pelos serviços disponíveis e clique em **Obter** para assinar. A maioria dos serviços oferece uma cota gratuita. diff --git a/ru/quickstart.mdx b/ru/quickstart.mdx index 5d5f5c58..ad4532e8 100644 --- a/ru/quickstart.mdx +++ b/ru/quickstart.mdx @@ -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). - Перейдите на [platform.acedata.cloud](https://platform.acedata.cloud) и завершите регистрацию. + Перейдите на [platform.acedata.cloud](https://platform.acedata.cloud/?utm_source=docs&utm_medium=quickstart&utm_campaign=docs-quickstart) и завершите регистрацию. Просмотрите доступные сервисы и нажмите **Получить** для подписки. Большинство сервисов предоставляют бесплатный лимит. diff --git a/scripts/check_quickstart_acquisition.py b/scripts/check_quickstart_acquisition.py new file mode 100644 index 00000000..182e1195 --- /dev/null +++ b/scripts/check_quickstart_acquisition.py @@ -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()) diff --git a/sr/quickstart.mdx b/sr/quickstart.mdx index 9f2a8cc8..2cbe842d 100644 --- a/sr/quickstart.mdx +++ b/sr/quickstart.mdx @@ -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. - 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. Pregledajte dostupne usluge i kliknite na **Preuzmi** da biste se pretplatili. Većina usluga nudi besplatan kvotu. diff --git a/sv/quickstart.mdx b/sv/quickstart.mdx index 3629e526..5e0af7c3 100644 --- a/sv/quickstart.mdx +++ b/sv/quickstart.mdx @@ -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). - 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. Bläddra bland tillgängliga tjänster och klicka på **Få** för att prenumerera. De flesta tjänster erbjuder gratis kvoter. diff --git a/tests/test_quickstart_acquisition.py b/tests/test_quickstart_acquisition.py new file mode 100644 index 00000000..2e84fcbd --- /dev/null +++ b/tests/test_quickstart_acquisition.py @@ -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() diff --git a/uk/quickstart.mdx b/uk/quickstart.mdx index 5b946769..155aed4f 100644 --- a/uk/quickstart.mdx +++ b/uk/quickstart.mdx @@ -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-ключ. - Перейдіть на [platform.acedata.cloud](https://platform.acedata.cloud) та завершіть реєстрацію. + Перейдіть на [platform.acedata.cloud](https://platform.acedata.cloud/?utm_source=docs&utm_medium=quickstart&utm_campaign=docs-quickstart) та завершіть реєстрацію. Перегляньте доступні сервіси, натисніть **Отримати** для підписки. Більшість сервісів надають безкоштовний ліміт. diff --git a/zh-Hans/quickstart.mdx b/zh-Hans/quickstart.mdx index 98ba4795..47df8962 100644 --- a/zh-Hans/quickstart.mdx +++ b/zh-Hans/quickstart.mdx @@ -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 diff --git a/zh-Hant/quickstart.mdx b/zh-Hant/quickstart.mdx index a8c2e3ea..f5f2a34d 100644 --- a/zh-Hant/quickstart.mdx +++ b/zh-Hant/quickstart.mdx @@ -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 憑證。 - 訪問 [platform.acedata.cloud](https://platform.acedata.cloud) 完成註冊。 + 訪問 [platform.acedata.cloud](https://platform.acedata.cloud/?utm_source=docs&utm_medium=quickstart&utm_campaign=docs-quickstart) 完成註冊。 瀏覽可用服務,點擊**獲取**完成訂閱。大部分服務提供免費額度。