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

Added step by step quickstart to create project and access API keys i… #764

Closed
wants to merge 23 commits into from

Conversation

Mikerniker
Copy link
Contributor

@pdeziel Hello, I tried adding the steps from the video tutorial. Will wait for feedback and if I need to make other changes.
Thank you.

Scope of changes

Added a step by step guide on creating a project and accessing API keys on the platform based on the video tutorials.

Type of change

  • new feature
  • bug fix
  • [X ] documentation
  • testing
  • technical debt
  • other (describe)

Acceptance criteria

  • Check if the documentation aligns with internal processes
  • Check for typos or other errors to links
  • Check for accuracy of information provided

Definition of Done

  • I have manually tested the change running it locally (having rebuilt all containers) or via unit tests
  • I have added unit and/or integration tests that cover my changes
  • I have added new test fixtures as needed to support added tests
  • I have updated the dependencies list if necessary (including updating yarn.lock and/or go.sum)
  • I have recompiled and included new protocol buffers to reflect changes I made if necessary
  • [ X] Check this box if a reviewer can merge this pull request after approval (leave it unchecked if you want to do it yourself)
  • I have notified the reviewer via Shortcut or Slack that this is ready for review
  • Front-end: Checked sm, md, lg screen resolutions for effective responsiveness
  • Backend-end: Documented service configuration changes or created related devops stories

Reviewer(s) checklist

  • Front-end: I've reviewed the Figma design and confirmed that changes match the spec.
  • Any new user-facing content that has been added for this PR has been QA'ed to ensure correct grammar, spelling, and understandability.
  • Are there any TODOs in this PR that should be turned into stories?

Copy link
Contributor

@pdeziel pdeziel left a comment

Choose a reason for hiding this comment

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

Awesome PR, I really like the tips and important sections, they look really good in the docs.

I did have several suggestions to streamline the wording and such but overall this is a great addition.

docs/content/getting-started/_index.md Outdated Show resolved Hide resolved
docs/content/getting-started/_index.md Outdated Show resolved Hide resolved
docs/content/getting-started/_index.md Outdated Show resolved Hide resolved
docs/content/getting-started/_index.md Outdated Show resolved Hide resolved
docs/content/getting-started/_index.md Outdated Show resolved Hide resolved
docs/content/getting-started/_index.md Outdated Show resolved Hide resolved
docs/content/getting-started/_index.md Outdated Show resolved Hide resolved
docs/content/getting-started/_index.md Outdated Show resolved Hide resolved
docs/content/getting-started/_index.md Outdated Show resolved Hide resolved
docs/content/getting-started/_index.md Outdated Show resolved Hide resolved
Mikerniker and others added 18 commits October 5, 2023 00:42
Co-authored-by: Patrick Deziel <42919891+pdeziel@users.noreply.github.com>
Signed-off-by: Mik Watkins <63586831+Mikerniker@users.noreply.github.com>
…pening' to 'creating'

Co-authored-by: Patrick Deziel <42919891+pdeziel@users.noreply.github.com>
Signed-off-by: Mik Watkins <63586831+Mikerniker@users.noreply.github.com>
Co-authored-by: Patrick Deziel <42919891+pdeziel@users.noreply.github.com>
Signed-off-by: Mik Watkins <63586831+Mikerniker@users.noreply.github.com>
…eo tutorials

Co-authored-by: Patrick Deziel <42919891+pdeziel@users.noreply.github.com>
Signed-off-by: Mik Watkins <63586831+Mikerniker@users.noreply.github.com>
Co-authored-by: Patrick Deziel <42919891+pdeziel@users.noreply.github.com>
Signed-off-by: Mik Watkins <63586831+Mikerniker@users.noreply.github.com>
…c creation tutorial

Co-authored-by: Patrick Deziel <42919891+pdeziel@users.noreply.github.com>
Signed-off-by: Mik Watkins <63586831+Mikerniker@users.noreply.github.com>
… authentication link

Co-authored-by: Patrick Deziel <42919891+pdeziel@users.noreply.github.com>
Signed-off-by: Mik Watkins <63586831+Mikerniker@users.noreply.github.com>
Co-authored-by: Patrick Deziel <42919891+pdeziel@users.noreply.github.com>
Signed-off-by: Mik Watkins <63586831+Mikerniker@users.noreply.github.com>
… access

Co-authored-by: Patrick Deziel <42919891+pdeziel@users.noreply.github.com>
Signed-off-by: Mik Watkins <63586831+Mikerniker@users.noreply.github.com>
Co-authored-by: Patrick Deziel <42919891+pdeziel@users.noreply.github.com>
Signed-off-by: Mik Watkins <63586831+Mikerniker@users.noreply.github.com>
Co-authored-by: Patrick Deziel <42919891+pdeziel@users.noreply.github.com>
Signed-off-by: Mik Watkins <63586831+Mikerniker@users.noreply.github.com>
Co-authored-by: Patrick Deziel <42919891+pdeziel@users.noreply.github.com>
Signed-off-by: Mik Watkins <63586831+Mikerniker@users.noreply.github.com>
…ing Topics link

Co-authored-by: Patrick Deziel <42919891+pdeziel@users.noreply.github.com>
Signed-off-by: Mik Watkins <63586831+Mikerniker@users.noreply.github.com>
…uctions

Co-authored-by: Patrick Deziel <42919891+pdeziel@users.noreply.github.com>
Signed-off-by: Mik Watkins <63586831+Mikerniker@users.noreply.github.com>
Fix the Generate API Key instructions

Co-authored-by: Patrick Deziel <42919891+pdeziel@users.noreply.github.com>
Signed-off-by: Mik Watkins <63586831+Mikerniker@users.noreply.github.com>
Fixed instructions for Client ID and Client Secret

Co-authored-by: Patrick Deziel <42919891+pdeziel@users.noreply.github.com>
Signed-off-by: Mik Watkins <63586831+Mikerniker@users.noreply.github.com>
Fixed instructions for API creation tutorial

Co-authored-by: Patrick Deziel <42919891+pdeziel@users.noreply.github.com>
Signed-off-by: Mik Watkins <63586831+Mikerniker@users.noreply.github.com>
Co-authored-by: Patrick Deziel <42919891+pdeziel@users.noreply.github.com>
Signed-off-by: Mik Watkins <63586831+Mikerniker@users.noreply.github.com>
@Mikerniker
Copy link
Contributor Author

Okay, thank you @pdeziel , I tried to commit your suggestions, I'm not sure if I did this correctly, but let me know if I missed something or if I still need to make other changes. Thank you for your help
.

Copy link
Contributor

@pdeziel pdeziel left a comment

Choose a reason for hiding this comment

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

Looks great, thanks for making the updates! I'll merge the PR once the checks pass.

@Mikerniker
Copy link
Contributor Author

Ok, thanks @pdeziel !

@pdeziel
Copy link
Contributor

pdeziel commented Oct 4, 2023

@Mikerniker I forgot that due to the settings we have on this repo, all commits have to have a GPG commit signature. That's on us because we don't have an official contributing guide yet...

The easiest way to resolve this is to open a new PR and create a brand new commit once you have the GPG key set up on your end. Setting up GPG signing is a bit annoying the first time, so if you feel it's a waste of your time I can just open a new PR and make sure you're credited when it gets merged.

Let me know which direction you want to go.

@Mikerniker
Copy link
Contributor Author

Okay, let me try to study and figure out how to set up a GPG key and if I get lost, I'll maybe go for the second option. Will get back on this when or if I am able to set it up. Thanks!

…n _index based on video tutorials. Incorporated pdiezels suggestions
…n _index based on video tutorials. Incorporated pdiezels suggestions
@Mikerniker
Copy link
Contributor Author

Hi @pdeziel I have set up the GPG signature and I'm currently trying to figure out how to open a new PR. --> when I click open a new PR I keep getting redirected to this page... am I supposed to click "Close with comment" button here first? Sorry, I'm still new at making PRs...

@pdeziel
Copy link
Contributor

pdeziel commented Oct 5, 2023

Hi @pdeziel I have set up the GPG signature and I'm currently trying to figure out how to open a new PR. --> when I click open a new PR I keep getting redirected to this page... am I supposed to click "Close with comment" button here first? Sorry, I'm still new at making PRs...

@Mikerniker The way I would do it is create a new branch on your fork and open a PR from that one with the signed commit. Unfortunately if you add signed commits on this branch it still won't work, because the original commit you added here yesterday was not signed and it wants all the commits to be signed.

@Mikerniker
Copy link
Contributor Author

Ok got it, will try that now, thanks!

@pdeziel pdeziel closed this Oct 5, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants