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

DXCDT-271: Add ci step to check that docs are up to date #560

Merged
merged 1 commit into from
Dec 15, 2022

Conversation

sergiught
Copy link
Contributor

@sergiught sergiught commented Dec 15, 2022

🔧 Changes

In order for us to always have up to date documentation for our customers, we're adding a ci step to alert us if there's any drift between what we publish and what we have within the commands help text.

📚 References

🔬 Testing

📝 Checklist

  • All new/changed/fixed functionality is covered by tests (or N/A)
  • I have added documentation for all new/changed functionality (or N/A)

@sergiught sergiught changed the base branch from main to v1 December 15, 2022 13:20
@sergiught sergiught self-assigned this Dec 15, 2022
@sergiught sergiught marked this pull request as ready for review December 15, 2022 13:29
@sergiught sergiught requested a review from a team as a code owner December 15, 2022 13:29
Copy link
Contributor

@Widcket Widcket left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Good idea!

@sergiught sergiught merged commit 2673c23 into v1 Dec 15, 2022
@sergiught sergiught deleted the patch/DXCDT-271-auto-docs branch December 15, 2022 18:26
willvedd added a commit that referenced this pull request Dec 21, 2022
* DXCDT-287: Remove format flag in favor of json flag (#533)

* DXCDT-288: Add perms alias for permissions subcommand (#534)

* DXCDT-286: Relegate --force flag from global context (#535)

* DXCDT-286: Hide global flags from commands when not applicable (#536)

* [1/4] DXCDT-266: Move domains subcommand one level up the hierarchy (#539)

* [2/4] DXCDT-266: Bring branding emails command under email templates (#540)

* Back-merging `main` into `v1` (#543)

DXCDT-293: Access token management for client credentials (#537)

* Storing and refreshing access token for client credentials

* Removing unnecessary comment

* Removing tenant name from being stored, removing flag declarations

* Removing tenant name from being stored

* Fixing erroneous delete

* Simplifying ExpiresAt assignment

* Remove duplicate addTenant in tenants add command

* Remove setting scopes on tenant when using client credentials

* Refactor how we check for token expiration while preparing the tenant

* Refactor cli.prepareTenant func

* Refactor cli.setup func

Co-authored-by: Will Vedder <will.vedder@okta.com>
Co-authored-by: Sergiu Ghitea <sergiu.ghitea@okta.com>

Co-authored-by: Will Vedder <will.vedder@okta.com>
Co-authored-by: Sergiu Ghitea <sergiu.ghitea@okta.com>

* [3/4] DXCDT-266: Rename branding cmd to universal-login (#541)

* [4/4] DXCDT-266: Update docs after branding command refactor (#542)

* DXCDT-283: Remove `config` command (#532)

Co-authored-by: Will Vedder <will.vedder@okta.com>

* DXCDT-267: Consolidate `auth0 add tenants` into `auth0 login` (1/x) (#546)

Co-authored-by: Will Vedder <will.vedder@okta.com>
Co-authored-by: Sergiu Ghitea <sergiu.ghitea@okta.com>

* DXCDT-267: Graceful handling of access token regeneration (2/x) (#547)

Co-authored-by: Rita Zerrizuela <zeta@widcket.com>
Co-authored-by: Will Vedder <will.vedder@okta.com>
Co-authored-by: Sergiu Ghitea <sergiu.ghitea@okta.com>

* DXCDT-298: Interactive login prompt (3/x) (#551)

Co-authored-by: Rita Zerrizuela <zeta@widcket.com>
Co-authored-by: Will Vedder <will.vedder@okta.com>
Co-authored-by: Sergiu Ghitea <28300158+sergiught@users.noreply.github.com>
Co-authored-by: Sergiu Ghitea <sergiu.ghitea@okta.com>

* DXCDT-295: Refactor quickstarts command to use quickstart meta URL (#553)

* DXCDT-297: Remove env var ingestion (#554)

Removing environment variable ingestion, removing unnecessary comment

Co-authored-by: Will Vedder <will.vedder@okta.com>

* DXCDT-271: Add ci step to check that docs are up to date (#560)

* DXCDT-271: Move bundle install out of make docs and into docs-start (#562)

* DXCDT-296: Supporting additional scopes when authenticating as user (#561)

* Adding additional scopes support via --scopes flag

* Adding additional scopes support via --scopes flag

* Removing logging

* Uncommenting scope, removing Start function

* Condensing error to single line

* Fixing linting errors

* Changing test

* Updating docs

* Unpluralizing text, setting nil default value

* Fixing bad help text

* Tiny refactors on the login cmd

* Fixing linting error

* Update internal/auth/auth.go

Co-authored-by: Will Vedder <will.vedder@okta.com>
Co-authored-by: Rita Zerrizuela <zeta@widcket.com>
Co-authored-by: Sergiu Ghitea <sergiu.ghitea@okta.com>
Co-authored-by: Sergiu Ghitea <28300158+sergiught@users.noreply.github.com>

* DXCDT-271: Fix generated docs (#563)

* Rename build_doc to doc-gen

* Downgrade json flag from persistent to local

* Update doc pages

* DXCDT-272 Add install script and update README (#564)

Co-authored-by: Will Vedder <willvedd@gmail.com>
Co-authored-by: Will Vedder <will.vedder@okta.com>

* DXCDT-273: Authentication documentation (#565)

Co-authored-by: Will Vedder <will.vedder@okta.com>

* Updating README

* Targeting main branch before we forget to change back

Co-authored-by: Sergiu Ghitea <28300158+sergiught@users.noreply.github.com>
Co-authored-by: Will Vedder <will.vedder@okta.com>
Co-authored-by: Sergiu Ghitea <sergiu.ghitea@okta.com>
Co-authored-by: Rita Zerrizuela <zeta@widcket.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants