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.

Sign up for GitHub

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

Jump to bottom

New IA - Authentication & Authorization #5690

Merged
merged 83 commits into from
Nov 25, 2024
Merged

New IA - Authentication & Authorization #5690

merged 83 commits into from
Nov 25, 2024
+2,984 −3,035

Conversation

DavidRollins
Copy link
Collaborator

@DavidRollins DavidRollins commented Nov 1, 2024 •
edited
Loading

User description

For internal users - Please add a Jira DX PR ticket to the subject!


Preview Link

https://deploy-preview-5690--tyk-docs.netlify.app/docs/nightly/api-management/authentication-authorization/

Description

  1. Describe your changes in detail. Why is this change required? What problem does it solve?
    Update the authentication and authorization page to consolidate content around authentication types and how to secure your apis in Tyk

    1. Please explain the change to the reviewer. Pay special attention to changes that are hard to spot
      2.1 Updated the navigation to each section, added badges, edited the intro
      2.2 Reorganized the page into key sections:
image 
   2.3 Updated the menu.yaml and deleted the redundant content

 3. @mentions of the person to review the proposed changes. They need to be able to know the topic well in order to approve it.

@letzya
@sharadregoti

Screenshots (if appropriate)


Checklist

  • I have added a preview link to the PR description.
  • I have reviewed the suggestions made by our AI (PR Agent) and updated them accordingly (spelling errors, rephrasing, etc.)
  • I have reviewed the guidelines for contributing to this repository.
  • I have read the technical guidelines for contributing to this repository.
  • Make sure you have started your change off our latest master.
  • I labeled the PR

PR Type

Documentation

Description

  • Added a new comprehensive documentation page for authentication and authorization in Tyk, covering various methods such as OAuth 2.0, JWT, mTLS, and more.
  • Included detailed setup instructions, examples, and configurations for implementing these authentication methods.
  • Updated the navigation menu to include the new "Authentication and Authorization" page, enhancing accessibility to the documentation.

Changes walkthrough 📝

Relevant files
Documentation
authentication-authorization.md
Add detailed authentication and authorization documentation

tyk-docs/content/api-management/authentication-authorization.md

  • Added comprehensive documentation on authentication and authorization
    methods in Tyk.
  • Detailed setup instructions for OAuth 2.0, JWT, mTLS, and other
    authentication methods.
  • Included examples and configurations for various authentication flows.
  • Provided guidance on integrating external OAuth providers and using Go
    plugins.
    		•  +1735/-0
    Configuration changes
    menu.yaml
    Update menu to include authentication documentation           

    tyk-docs/data/menu.yaml

  • Added a new menu entry for "Authentication and Authorization".
  • Updated the navigation structure to include the new documentation
    page.
    		•  +4/-0     

    💡 PR-Agent usage: Comment /help "your question" on any pull request to receive relevant information

    @DavidRollins DavidRollins self-assigned this Nov 1, 2024
    @github-actions GitHub Actions
    Copy link
    Contributor

    github-actions bot commented Nov 1, 2024

    PR Reviewer Guide 🔍

    Here are some key observations to aid the review process:

    ⏱️ Estimated effort to review: 5 🔵🔵🔵🔵🔵
    🧪 No relevant tests
    🔒 No security concerns identified
    ⚡ Recommended focus areas for review

    Content Duplication
    The document contains extensive details about OAuth 2.0, bearer tokens, and other authentication methods which might be redundant or overly detailed for users just looking for configuration steps. Consider summarizing or restructuring to improve readability and usability.

    Possible Security Concern
    Ensure that all external links and embedded content (like YouTube videos and external OAuth endpoints) are from trusted sources to avoid security risks such as phishing or code injection.

    Performance Issue
    The document is very large and covers multiple authentication methods in one page. Consider splitting into sub-pages for each authentication method to improve load times and user navigation.

    @github-actions GitHub Actions
    Copy link
    Contributor

    github-actions bot commented Nov 1, 2024

    PR Code Suggestions ✨

    No code suggestions found for the PR.

    @netlify Netlify
    Copy link

    netlify bot commented Nov 1, 2024 •
    edited
    Loading

    ✅ PS. Pls add /docs/nightly to the end of url

    Name Link
    🔨 Latest commit f5bd4c6
    🔍 Latest deploy log https://app.netlify.com/sites/tyk-docs/deploys/674460c51c038b0008b07d01
    😎 Deploy Preview https://deploy-preview-5690--tyk-docs.netlify.app
    📱 Preview on mobile
    Toggle QR Code...

    QR Code

    Use your smartphone camera to open QR code link.

    To edit notification comments on pull requests, go to your Netlify site configuration.

    @letzya
    Copy link
    Collaborator

    letzya commented Nov 4, 2024

    @DavidRollins the PR has conflicts and also I don't see that the deleted pages have been added as aliases

    @sharadregoti sharadregoti changed the title Authn new ia New IA - Authentication & Authorization Nov 6, 2024
    DavidRollins and others added 11 commits November 6, 2024 15:05
    @DavidRollins
    pull latest updates
    5935da7
    @DavidRollins
    resolve conflicts
    8b7a055
    @DavidRollins
    fix links
    c760d3f
    @DavidRollins
    update openid connect
    436ec32
    @DavidRollins
    update openid connect
    e008195
    @titpetric @andyo-tyk
    @jeffy-mathew @sharadregoti @DavidRollins
    [TT-13263/TT-13264] Add plugin development docs update (#5565)
    9ae2d16 
    * Add plugin development docs update

---------

Co-authored-by: Tit Petric <[email protected]>
Co-authored-by: andyo-tyk <[email protected]>
Co-authored-by: Jeffy Mathew <[email protected]>
Co-authored-by: Sharad Regoti <[email protected]>
    @caroltyk @DavidRollins
    DX-1750 Update MDCB quick start instructions (#5684)
    23a9ff6
    @Eopayemi @andyo-tyk
    @letzya @DavidRollins
    [DX-1722] Deprecation announcement (#5643)
    55f0170 
    * deprecation

* ODIC

* Update tyk-docs/content/basic-config-and-security/security/authentication-authorization/openid-connect.md

Co-authored-by: andyo-tyk <[email protected]>

* Update tyk-docs/content/basic-config-and-security/security/authentication-authorization/ext-oauth-middleware.md

Co-authored-by: andyo-tyk <[email protected]>

* Update tyk-docs/content/tyk-dashboard/database-options.md

Co-authored-by: andyo-tyk <[email protected]>

* remove odd file

---------

Co-authored-by: andyo-tyk <[email protected]>
Co-authored-by: Yaara <[email protected]>
    @jeffy-mathew @andyo-tyk @DavidRollins
    [TT-13281/TT-13282] Document OAS common parameter usage in dashboard …
    eab9722 
    …OAS endpoint designer (#5682)

Co-authored-by: andyo-tyk <[email protected]>
    @sharadregoti @letzya @DavidRollins
    [DX-1728]-Fixed 5.3 RNs (#5666)
    9ffc8c3 
    Co-authored-by: Yaara <[email protected]>
    @caroltyk @sharadregoti
    @letzya @DavidRollins
    Update operator-1.0.md helm chart (#5691)
    94a2cd0 
    * Update operator-1.0.md helm chart

* fixes

* Update tyk-docs/content/product-stack/tyk-operator/release-notes/operator-1.0.md

---------

Co-authored-by: Master <[email protected]>
Co-authored-by: Yaara <[email protected]>
    @sharadregoti sharadregoti merged commit 9a30614 into master Nov 25, 2024
    9 checks passed
    @sharadregoti sharadregoti deleted the authn_new_IA branch November 25, 2024 11:38
    @sharadregoti
    Copy link
    Contributor

    /release to release-5.6

    @tykbot tykbot
    Copy link

    tykbot bot commented Nov 25, 2024

    Working on it! Note that it can take a few minutes.

    tykbot bot pushed a commit that referenced this pull request Nov 25, 2024
    @DavidRollins
    New IA - Authentication & Authorization (#5690)
    79357f5 
    (cherry picked from commit 9a30614)
    @buger buger mentioned this pull request Nov 25, 2024
    Merged
    @tykbot tykbot
    Copy link

    tykbot bot commented Nov 25, 2024

    @sharadregoti Succesfully merged PR

    sharadregoti pushed a commit that referenced this pull request Nov 25, 2024
    @buger
    Merging to release-5.6: New IA - Authentication & Authorization (#5690)…
    0d663c0 
    … (#5751)
    Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
    Reviewers

    @sharadregoti sharadregoti sharadregoti approved these changes

    Assignees

    @DavidRollins DavidRollins

    Labels
    New IA Project Review effort [1-5]: 5
    Projects
    None yet
    Milestone
    No milestone
    Development

    Successfully merging this pull request may close these issues.
    8 participants
    @DavidRollins @letzya @sharadregoti @titpetric @caroltyk @Eopayemi @jeffy-mathew @tbuchaillot