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

Update "Getting started" guide after setting up local environment #297

Merged
merged 4 commits into from
Jul 28, 2023
Merged

Update "Getting started" guide after setting up local environment #297

merged 4 commits into from
Jul 28, 2023

Conversation

pawiecz
Copy link
Contributor

@pawiecz pawiecz commented Jul 13, 2023

Endpoint "/me" was replaced with "/whoami" in:
ef04597

@pawiecz
Copy link
Contributor Author

pawiecz commented Jul 13, 2023

(This PR will be updated with further changes)

JenySadadia
JenySadadia reviewed Jul 13, 2023
View reviewed changes
doc/getting-started.md Outdated Show resolved Hide resolved
@pawiecz
doc: specify working directories for Getting Started sections
f9324be 
Repositories "kernelci-api" and "kernelci-pipeline" were mentioned on
the "API & Pipeline" docs index page but not referred in the Getting
Started guide.

Signed-off-by: Paweł Wieczorek <[email protected]>
@pawiecz
doc: replace /me endpoint with /whoami
2e43a18 
Endpoint "/me" was replaced with "/whoami" in:
ef04597

Signed-off-by: Paweł Wieczorek <[email protected]>
@pawiecz
doc: update /whoami endpoint "id" response field
66dc425 
Name of the field has changed from "_id" to "id" as a part of PR kernelci#280.

Signed-off-by: Paweł Wieczorek <[email protected]>
@pawiecz
doc: add a note on the best practice for API token usage
15c745b 
Signed-off-by: Paweł Wieczorek <[email protected]>
@pawiecz pawiecz force-pushed the update-getting-started-guide branch from dcd56a7 to 15c745b Compare July 26, 2023 08:34
@pawiecz pawiecz changed the title Replace /me endpoint with /whoami Update "Getting started" guide after setting up local environment Jul 26, 2023
@pawiecz
Copy link
Contributor Author

pawiecz commented Jul 26, 2023

There are still two subtasks which could be useful:

  • updating raw curl requests to kci tool commands
  • updating test set available by default

but I should not block other changes to the docs with this PR anymore.

This branch also applies without conflicts when rebased on gctucker:doc-api-admin (I will update this PR when #312 is merged)

@pawiecz pawiecz marked this pull request as ready for review July 26, 2023 08:43
@gctucker
Copy link
Contributor

gctucker commented Jul 26, 2023 •
edited
Loading

  • updating raw curl requests to kci tool commands

I think it might be a bit early to start relying on the kci tool as it's not distributed as a PyPI package yet so the syntax is subject to evolve, but that's not a blocking issue. Of course it's easier to use than raw curl commands, let's just hope it stays in sync with the code if we go down that route.

gctucker
gctucker reviewed Jul 26, 2023
View reviewed changes
Copy link
Contributor

@gctucker gctucker left a comment

Choose a reason for hiding this comment

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

LGTM - let's wait until this appears on the staging website to double check it looks as expected:
https://static.staging.kernelci.org/docs/api/getting-started/

@JenySadadia
Copy link
Collaborator

Tested OK on staging.

@JenySadadia JenySadadia added this pull request to the merge queue Jul 28, 2023
Merged via the queue into kernelci:main with commit 7a5e25b Jul 28, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@JenySadadia JenySadadia JenySadadia left review comments

@gctucker gctucker gctucker left review comments

Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
3 participants
@pawiecz @gctucker @JenySadadia