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

update README api keys section to reflect api endpoint change (https://github.com/gabledata/product/pull/811) #41

Merged
merged 1 commit into from
Dec 21, 2023

Conversation

alexdemeo
Copy link
Contributor

@alexdemeo alexdemeo commented Dec 11, 2023

In light of https://github.com/gabledata/product/pull/811, include the new change in the readme

here's the new change rendered:
Screenshot 2023-12-11 at 1 16 00 PM

@alexdemeo alexdemeo marked this pull request as ready for review December 11, 2023 21:17
@alexdemeo
Copy link
Contributor Author

I'm guessing we should wait to merge this until the release goes through?

@mjperrone
Copy link

Also please check if there is anywhere in the product docs that needs to be updated.

@mjperrone
Copy link

mjperrone commented Dec 11, 2023

I'm guessing we should wait to merge this until the release goes through?

@geoffrey can you advise on waiting to merge documentation changes in relation to product releases? (release process is related but I'm not sure covers this)

- An API key that corresponds to the endpoint

You can find your API key by navigating to the `Settings -> API Keys` page of Gable. Under API Keys you can click `View` to reveal your API key.
You can find your API endpoint and key by navigating to the `Settings -> API Keys` page of Gable. Under API Keys you can click `View` to reveal your API key.

Choose a reason for hiding this comment

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

It sucks that we can't link directly to this because the domain differs per customer. We would have to have some way of noticing which deployment they're auth'd against (maybe this is accessible in cookies somehow?) and redirect to it.

@gwukelic
Copy link
Contributor

I'm guessing we should wait to merge this until the release goes through?

@geoffrey can you advise on waiting to merge documentation changes in relation to product releases? (release process is related but I'm not sure covers this)

We should wait on merging this until after the product release on Tuesday. I can take control of this PR and make sure it gets merged after the release if you want? Either way I'm going to set a personal reminder to make sure this gets merged next week.

Additionally, I've added some notes to the Release Process Notion page. This is not a perfect process and should be discussed and revised at a later time. However, I don't think it's a priority. I'm going to page @adrianisk and @DevopsAdrian in Slack (as well as here) to add visibility.

Lastly, @geoffrey is not my github handle (I wish I was the first Geoffrey on here!) which is why I missed this comment. Going forward you'll have to use @gwukelic

@gwukelic gwukelic merged commit 014e857 into main Dec 21, 2023
2 checks passed
@alexdemeo alexdemeo deleted the ad/api-endpoint-readme branch December 21, 2023 17:58
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