From 2a83a7126592ff11d48ed204ee4e876c7bdf659c Mon Sep 17 00:00:00 2001 From: Olivier Sprangers Date: Fri, 22 Nov 2024 19:42:28 +0100 Subject: [PATCH] fix_pricing_links --- CONTRIBUTING.md | 7 +++++-- nbs/docs/getting-started/5_faq.ipynb | 4 ++-- 2 files changed, 7 insertions(+), 4 deletions(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 89debab5..aec096b0 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -81,7 +81,9 @@ Docs are automatically created from the notebooks in the `nbs` folder. ### Modifying an existing doc 1. Find the relevant notebook. -2. Make your changes. DO NOT rename the document! +2. Make your changes. + * Do not rename the document. + * Do not change the first header (title). The first header is used in Readme.com to create the filename. For example, a first header of `TimeGPT Subscription Plans and Pricing` in folder `getting-started` will result in the following online link to the document: `https://docs.nixtla.io/docs/getting-started-timegpt_subscription_plans_and_pricing`. 3. Run all cells. 4. Run `nbdev_preview`. 5. Clean the notebook metadata using `nbdev_clean --fname nbs/docs/[path_to_notebook.ipynb]`. @@ -92,7 +94,8 @@ Docs are automatically created from the notebooks in the `nbs` folder. ### Creating a new document 1. Copy an existing jupyter notebook in a folder where you want to create a new document. This should be a subfolder of `nbs/docs`. 2. Rename the document using the following format: `[document_number]_document_title_in_lower_case.ipynb` (for example: `01_quickstart.ipynb`), incrementing the document number from the current highest number within the folder and retaining the leading zero. -3. Work on your new document. Pay attention to: +3. The first header (title) is ideally the same as the notebook name (without the document number). This is because in Readme.com the first header (title) is used to create the filename. For example, a first header of `TimeGPT Subscription Plans and Pricing` of a document in folder `getting-started` will result in the following online link to the document: `https://docs.nixtla.io/docs/getting-started-timegpt_subscription_plans_and_pricing`. Thus, it is advised to keep the document name and header the same. +4. Work on your new document. Pay attention to: * The Google Colab link; * How images should be linked; * How the `IN_COLAB` variable is used to distinguish when the notebook is used locally vs in Google Colab. diff --git a/nbs/docs/getting-started/5_faq.ipynb b/nbs/docs/getting-started/5_faq.ipynb index 933b6a37..775d77f8 100644 --- a/nbs/docs/getting-started/5_faq.ipynb +++ b/nbs/docs/getting-started/5_faq.ipynb @@ -426,13 +426,13 @@ "
\n", " How does pricing work?\n", "\n", - "`TimeGPT` has a flat fee pricing structure with subscription. See our [Pricing page](https://docs.nixtla.io/docs/getting-started-pricing) for information and find a plan for your needs. We have a subscription plan to meet your needs. You can cancel anytime. \n", + "`TimeGPT` has a flat fee pricing structure with subscription. See our [Pricing page](https://docs.nixtla.io/docs/getting-started-timegpt_subscription_plans_and_pricing) for information and find a plan for your needs. We have a subscription plan to meet your needs. You can cancel anytime. \n", "\n", "\n", "[Start for Free](https://dashboard.nixtla.io/) \n", "*No credit card needed. Free plan available. \n", "\n", - "For pricing of TimeGEN-1 on Azure, see the [pricing page](https://docs.nixtla.io/docs/getting-started-pricing#azure-timegen-pricing).\n", + "For pricing of TimeGEN-1 on Azure, see the [pricing page](https://docs.nixtla.io/docs/getting-started-timegpt_subscription_plans_and_pricing#azure-timegen-pricing).\n", "\n", "
" ]