Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Restructure, reformat and rewrite API Compatibility Documentation #1337

Merged
merged 12 commits into from
Dec 7, 2023

Commits on Nov 29, 2023

  1. Migrate docs to docs.nginx.com (nginxinc#1226)

    Change docs structure and add the required files to build documentation Hugo and publish with Netlify
    
    Rewrite existing docs to work with Hugo
    
    
    ---------
    
    Co-authored-by: Travis Martin <[email protected]>
    Co-authored-by: Travis Martin <[email protected]>
    Co-authored-by: Kate Osborn <[email protected]>
    Co-authored-by: Alan Dooley <[email protected]>
    Co-authored-by: Alan Dooley <[email protected]>
    6 people authored Nov 29, 2023
    Configuration menu
    Copy the full SHA
    110df75 View commit details
    Browse the repository at this point in the history

Commits on Nov 30, 2023

  1. Configuration menu
    Copy the full SHA
    a5ae669 View commit details
    Browse the repository at this point in the history
  2. Fix installation docs for mismatched versions (nginxinc#1287)

    Problem: Our installation docs suggested installing Gateway API v1 and NGF v1, which are not compatible.
    
    Solution: Fix the docs to mention both stable and edge versions, with proper versioning. Also updated the release process doc to ensure these are updated at release time as needed.
    sjberman authored Nov 30, 2023
    Configuration menu
    Copy the full SHA
    e886318 View commit details
    Browse the repository at this point in the history
  3. Update Control Plane Configuration documentation for Hugo formatting (n…

    …ginxinc#1296)
    
    This commit updates the control plane configuration documentation to
    match NGINX's standardised Hugo formatting conventions: specifically,
    avoiding breaking sentences across line and the use of shortcodes for a
    note. There are also some minor content changes for product noun
    conventions and rephrasing a few sentences.
    
    ---------
    
    Co-authored-by: Jon Torre <[email protected]>
    ADubhlaoich and Jcahilltorre authored Nov 30, 2023
    Configuration menu
    Copy the full SHA
    ba2b986 View commit details
    Browse the repository at this point in the history
  4. docs: update architecture doc (nginxinc#1295)

    * docs: update architecture doc
    
    * chore: update architecture description
    
    ---------
    
    Co-authored-by: Alan Dooley <[email protected]>
    Jcahilltorre and ADubhlaoich authored Nov 30, 2023
    Configuration menu
    Copy the full SHA
    fdeec8f View commit details
    Browse the repository at this point in the history
  5. Configuration menu
    Copy the full SHA
    afb7c09 View commit details
    Browse the repository at this point in the history

Commits on Dec 5, 2023

  1. Restructure, reformat and rewrite API Compatibility Documentation

    This commit makes a few changes to increase readability:
    
    - The table format from the summary is re-used for individual resources
    - The order of resources is changed to match the API specification
    - Capilisation and other style concerns have been standardised
    - Text has been rewritten for conciseness where possible
    
    I considered linking to the API specification sections to match the
    resources, but I noticed that they were versioned, which could possibly
    create issues for us in managing drift.
    ADubhlaoich committed Dec 5, 2023
    Configuration menu
    Copy the full SHA
    3693faa View commit details
    Browse the repository at this point in the history
  2. Configuration menu
    Copy the full SHA
    eff2e08 View commit details
    Browse the repository at this point in the history
  3. Configuration menu
    Copy the full SHA
    60b478d View commit details
    Browse the repository at this point in the history

Commits on Dec 6, 2023

  1. Configuration menu
    Copy the full SHA
    95bf251 View commit details
    Browse the repository at this point in the history
  2. Configuration menu
    Copy the full SHA
    b656a3c View commit details
    Browse the repository at this point in the history

Commits on Dec 7, 2023

  1. Configuration menu
    Copy the full SHA
    b69fe1f View commit details
    Browse the repository at this point in the history