Docs Release and Contribution Guide

tyk-docs/content/developer-support/contributing.md

@@ -5,20 +5,13 @@ tags: [ "Contributing", "Documentation", "Community" ]
 description: "How to contribute to Tyk documentation"
 aliases:
    - /contribute
+   - /ui-examples/feature-cards 
+   - /ui-examples/test-pill-label 
+   - /ui-examples/youtube-video-embed
 ---
 
 This section provides resources and guidance for contributors to Tyk's documentation. Whether you're fixing a typo, adding new content, or helping improve our documentation standards, you'll find the tools and guidelines you need here.
 
-## What this section covers
-
-This contribution section includes:
-
-- **[Inclusive naming]({{< ref "developer-support/documentation-projects/inclusive-naming" >}})** - Information about Tyk's inclusive language initiative and the work done to update documentation terminology
-- **UI component examples** - Documentation and examples for using shortcodes in our documentation system:
-  - **[Pill label shortcode]({{< ref "ui-examples/test-pill-label" >}})** - For labeling content with edition indicators (Enterprise, Cloud, Lab Release, etc.)
-  - **[Feature cards shortcode]({{< ref "ui-examples/feature-cards" >}})** - For creating responsive feature highlight grids
-  - **[YouTube video embed shortcode]({{< ref "ui-examples/youtube-video-embed" >}})** - For embedding videos with proper styling and SEO
-
 ## How to contribute to our docs
 
 We appreciate any form of engagement and contribution to our documentation. You can contribute in several ways:
@@ -36,5 +29,4 @@ For detailed contribution guidelines, including pull request requirements, codin
 
 ### Technical guidance
 
-Our docs are compiled using the [Hugo static site generator](https://gohugo.io/). For detailed technical guidance on creating and updating documentation pages, see the [technical guide](https://github.com/TykTechnologies/tyk-docs/blob/master/CONTRIBUTING-TECHNICAL-GUIDE.md) referenced in our [CONTRIBUTING.md](https://github.com/TykTechnologies/tyk-docs/blob/master/CONTRIBUTING.md) file.
-
+Our docs uses [Mintlify](https://mintlify.com/). For detailed technical guidance on creating and updating documentation pages, see the [technical guide]({{< ref "developer-support/contribution-guides" >}}).

tyk-docs/content/developer-support/contribution-guides.md

@@ -0,0 +1,259 @@
+---
+title: "Contributing Guides"
+description: "Guide to releasing Tyk documentation"
+tags: ["Guides", "Contribution to Tyk", "Open source contribution guide"]
+---
+
+## Introduction
+
+Tyk documentation is built using [Mintlify](https://mintlify.com/), a platform that allows us to create, manage and publish our documentation. 
+This page provides an overview and guidelines to contributing to Tyk documentation, including setting up dev environment locally, creating new content, and utilize Mintlify's [UI objects](https://mintlify.com/docs/text).
+
+## Prerequisites - applys to all flows and tasks
+
+- You’ve set up the Tyk Docs local environment as described in the [Getting Started](#getting-started---running-mintlify-locally) section.
+- You have a basic understanding of [Page Structure](https://mintlify.com/docs/pages) and [Navigation](https://mintlify.com/docs/navigation) in Mintlify.
+- You’re familiar with Git and Markdown syntax.
+
+## Common steps for every task
+- Any update requires a PR
+- Please label your PR with the versions you want it to be added to
+- Please assign a reviewer that is also a stakeholder who can sign off the change
+
+## Getting Started - Running Mintlify locally
+
+This secion provides instructions for setting up your local environment to work with Tyk documentation using Mintlify.
+
+1. **Install Mintlify CLI globally**:
+   ```bash
+   npm install -g mint
+   ```
+2. **Clone the Tyk Docs repository**:
+   ```bash
+   git clone https://github.com/TykTechnologies/tyk-docs.git && cd tyk-docs
+   ```
+
+   For external contributions, you will need to fork the Tyk docs repository and clone your fork:
+   ```bash
+   git clone <fork-url>
+   cd tyk-docs
+   ```
+
+3. **Start the Mintlify development server**:
+   ```bash
+   mint dev
+   ```
+4. Open your browser and go to `http://localhost:3000` to view the documentation.
+
+## Creating a New Page
+
+To add a new page to the Tyk documentation, follow the steps below.
+
+1. **Switch to the `main` branch and pull the latest changes:**
+
+   ```bash
+   git checkout main
+   git pull origin main
+   ```
+
+2. **Create a new branch:**
+
+   ```bash
+   git checkout -b <branch-name>
+   ```
+
+3. **Create the new page:**
+
+   The content is organized into folders under the root directory, reflecting the website's navigation structure (tabs, groups, etc.). Choose the appropriate folder for your new page.
+
+   * Create a new `.mdx` file for the page. For example, for a page titled “API Versioning” you might create a file named `api-versioning.mdx`.
+   * Add [front matter](https://mintlify.com/docs/pages#frontmatter) to the top of the file. This is a YAML block containing metadata like the title, description, and tags.
+
+   **Example front matter:**
+
+   ```mdx
+   ---
+   title: "API Versioning"
+   description: "Create and manage multiple versions of an API"
+   sidebarTitle: "API Versioning"
+   tags: ['API versioning', 'version', 'Tyk Classic', 'Tyk OAS', 'API', 'versioning']
+   ---
+
+   <Insert Lead paragraph here.>
+   ```
+
+   * Write your content using Markdown. You can also use Mintlify UI components (e.g., accordions, callouts, code blocks) to improve readability and user experience.
+
+4. **Update `docs.json`:**
+
+   To make your new page appear in the navigation, update the `docs.json` file in the root directory.
+
+   **Example**: Adding a new page under the *"API Management"* tab in the *"Overview"* group.
+
+   ```json
+   {
+     ...
+     "navigation": {
+       "tabs": [
+         {
+           "tab": "API Management",
+           "groups": [
+             {
+               "group": "Overview",
+               "pages": [
+                 "tyk-overview",
+                 "tyk-components",
+                 "apim",
+                 "api-versioning"  // New page added here
+               ]
+             }
+           ]
+         }
+       ]
+     }
+     ...
+   }
+   ```
+
+5. **Commit and push your changes:**
+
+   ```bash
+   git add -A
+   git commit -m "Add new page: <page-name>"
+   git push origin <branch-name>
+   ```
+
+6. **Create a pull request** on GitHub to merge your changes into `main`.
+
+   Once the PR is opened, a series of automated checks will run:
+
+   *   Link Check: Mintlify checks for broken internal links.
+   *   Spell Check: A vale-spellcheck ensures content quality.
+   *   Documentation Validation: A custom script checks for things like missing images and redirect conflicts.
+
+7. **Preview your changes** using the link provided by Mintlify before merging.
+
+   **For Contributors Outside Tyk:** A Tyk team member will need to approve the Mintlify CI build for your pull request (PR). You will need to wait 
+   until the CI status is green.
+
+   **Locating Your Changes:** Since there's no search feature in this Mintlify build, you can find your changes by following these steps:
+      1.	**Copy the file path**: From the file path in GitHub, copy the path, excluding the `.md` file extension.
+      2.	**Construct the URL**: Append this copied path to the Mintlify URL after `/docs`.
+      3.	**Example**: To see the document at tyk-docs GitHub repository, copy `/tyk-self-managed/install` (omit `.md`) and add it after /docs/ in the Netlify URL, resulting in [https://branch-name.mintlify.app/docs/tyk-self-managed/install/](https://branch-name.mintlify.app/docs/tyk-self-managed/install/).
+
+8. **Merge to main (Updates Nightly)**
+
+   Once the PR is reviewed, approved, and all checks pass, it can be merged into `main`. This automatically triggers a deployment, and your changes will go live on the Nightly version of the docs.
+
+9. **Backporting to Release Versions (Cherry-Picking)**
+   If your change needs to be included in a stable release (e.g., v5.9):
+
+   1.  Go to your original, now-merged PR on GitHub.
+   2.  Add a label corresponding to the target version, for example, release-5.9.
+   3.  That's it! An automated bot (buger) will detect this label.
+
+   The bot will:
+
+   1.  Cherry-pick the commit from your original PR.
+   2.  Create a new PR with those changes, targeting the release-5.9 branch.
+   3.  Automatically merge this new PR once all checks pass.
+
+   The merge into the `release-5.9` branch triggers the `main` deployment workflow, which rebuilds the `production` branch. Mintlify detects the update and deploys the changes to the live v5.9 documentation.
+
+## Updating an Existing Page
+
+To make changes to an existing page in the Tyk documentation, follow these steps:
+
+1. **Switch to the `main` branch and pull the latest changes:**
+
+   ```bash
+   git checkout main
+   git pull origin main
+   ```
+
+2. **Create a new branch:**
+
+   ```bash
+   git checkout -b <branch-name>
+   ```
+
+3. **Locate and edit the page:**
+
+   * Navigate to the appropriate folder in the repository where the `.mdx` file for the page is located.
+   * Open the file and make your changes using Markdown syntax. You can enhance content using Mintlify UI components like callouts, accordions, tabs, and code blocks.
+   * If needed, update the front matter (e.g., `title`, `description`, `tags`) at the top of the file.
+
+4. **Preview your changes locally** to ensure formatting and layout appear as expected.
+
+   ```bash
+   mintlify dev
+   ```
+
+5. **Commit and push your changes:**
+
+   ```bash
+   git add .
+   git commit -m "<short-description-of-change>"
+   git push origin <branch-name>
+   ```
+
+6. **Create a pull request** on GitHub to merge your branch into `main`.
+
+7. **Review the preview link** provided in the pull request to verify your changes before merging.
+
+## Deleting a Page
+
+To delete a page from the Tyk documentation, follow these steps:
+
+1. **Switch to the `main` branch and pull the latest changes:**
+
+   ```bash
+   git checkout main
+   git pull origin main
+   ```
+
+2. **Create a new branch from `main`:**
+
+   ```bash
+   git checkout -b <branch-name>
+   ```
+
+3. **Delete the relevant Markdown file** corresponding to the page you want to remove.
+
+4. **Update `docs.json`:**
+
+   * Remove the entry for the deleted page from the `navigation` section.
+   * Add a redirect in the `redirect` section to point users to a relevant page. This prevents 404 errors when the deleted page is accessed.
+
+5. **Commit and push your changes:**
+
+   ```bash
+   git add .
+   git commit -m "Delete page: <page-name> - <Explain briefly the reason>"
+   git push origin <branch-name>
+   ```
+
+6. **Create a pull request** on GitHub to merge your branch into `main`.
+
+7. **Review the preview link** provided by Mintlify to ensure your changes appear as expected before merging.
+
+## Guide for UI features
+
+Apart from the basic markdown writing, Tyk documentation also support UI components like accordions, callouts, cards, expandables, tabs etc. These components help in  enhance the documentation's usability and readability.
+
+Here's a table summarizing the UI features available for Tyk documentation:
+
+| Name | Description |
+|------|-------------|
+| [Code Blocks](https://mintlify.com/docs/code) | Display inline code and code blocks |
+| [Accordions](https://mintlify.com/docs/components/accordions) | A dropdown component to toggle content visibility |
+| [Callouts](https://mintlify.com/docs/components/callouts) | Use callouts to add eye-catching context to your content |
+| [Cards](https://mintlify.com/docs/components/cards) | Highlight main points or links with customizable icons |
+| [Expandables](https://mintlify.com/docs/components/expandables) | Toggle to display nested properties. |
+| [Tabs](https://mintlify.com/docs/components/tabs) | Toggle content using the Tabs component |
+| [Mermaid](https://mintlify.com/docs/components/mermaid-diagrams) | Display diagrams using Mermaid |
+| [Steps](https://mintlify.com/docs/components/steps) | Sequence content using the Steps component |
+| Snipptet | A custom component written by us. TODO |
+
+**Note:** The above components is a list of mostly used components in Tyk documentation. To see the complete list of components, refer to the [Mintlify documentation](https://docs.mintlify.com/docs/components).
+