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

[docs] Add oauth token authentication workflow #2655

Merged
merged 12 commits into from
Feb 24, 2024

Conversation

fyrfli
Copy link
Contributor

@fyrfli fyrfli commented Feb 18, 2024

Add the api authentication workflow to the documentation

If this is a code change, please include a summary of what you've coded, and link to the issue(s) it closes/implements.

If this is a documentation change, please briefly describe what you've changed and why.

This pull request adds the api authentication workflow to the documents and addresses #1135.

Closes: #1135

Checklist

Please put an x inside each checkbox to indicate that you've read and followed it: [ ] -> [x]

If this is a documentation change, only the first checkbox must be filled (you can delete the others if you want).

  • I/we have read the GoToSocial contribution guidelines.
  • I/we have discussed the proposed changes already, either in an issue on the repository, or in the Matrix chat.
  • I/we have not leveraged AI to create the proposed changes.
  • I/we have performed a self-review of added code.
  • I/we have written code that is legible and maintainable by others.
  • I/we have commented the added code, particularly in hard-to-understand areas.
  • I/we have made any necessary changes to documentation.
  • I/we have added tests that cover new code.
  • I/we have run tests and they pass locally with the changes.
  • I/we have run go fmt ./... and golangci-lint run.

docs/api/authentication.md Outdated Show resolved Hide resolved
docs/api/authentication.md Outdated Show resolved Hide resolved
docs/api/authentication.md Outdated Show resolved Hide resolved
docs/api/authentication.md Outdated Show resolved Hide resolved
docs/api/authentication.md Outdated Show resolved Hide resolved
docs/api/authentication.md Outdated Show resolved Hide resolved
docs/api/authentication.md Outdated Show resolved Hide resolved
docs/api/authentication.md Outdated Show resolved Hide resolved
docs/api/authentication.md Outdated Show resolved Hide resolved
docs/api/authentication.md Outdated Show resolved Hide resolved
@daenney
Copy link
Member

daenney commented Feb 18, 2024

Overall this looks pretty great. I have some small stylistic/markup changes and once those get resolved I think this should be good to go!

You can see the rendered result here: https://gotosocial--2655.org.readthedocs.build/en/2655/api/authentication/. Once you push changes it'll automatically rebuild so you can see the effect of the changes.

@fyrfli
Copy link
Contributor Author

fyrfli commented Feb 18, 2024

sweet ... thanks for these. i will try and have them done today

@daenney
Copy link
Member

daenney commented Feb 18, 2024

No worries, it's the weekend! We'll be here all of next week 😉.

@fyrfli fyrfli requested a review from daenney February 18, 2024 20:58
docs/api/authentication.md Outdated Show resolved Hide resolved
Copy link
Member

@daenney daenney left a comment

Choose a reason for hiding this comment

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

Thanks for resolving the comments! There's one with a wrong header name and after that I think we're good to go.

Co-authored-by: Daenney <daenney@users.noreply.github.com>
@fyrfli
Copy link
Contributor Author

fyrfli commented Feb 19, 2024

done. surprised i missed that especially since i caught a few other typos earlier.

Copy link
Member

@daenney daenney left a comment

Choose a reason for hiding this comment

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

Awesome, thanks for this!

@fyrfli
Copy link
Contributor Author

fyrfli commented Feb 19, 2024

my pleasure. i've been looking for the opportunity to contribute for a while.

@daenney
Copy link
Member

daenney commented Feb 19, 2024

I'll leave it open for a day or two so the rest of the team has the opportunity to go through it too. If it doesn't get merged by anyone else I'll click the button on Wednesday.

@tsmethurst tsmethurst changed the title add authentication workflow to docs [docs] Add oauth token authentication workflow Feb 19, 2024
@tsmethurst
Copy link
Contributor

This is looking good :) I'll have a proper look through it this afternoon. Thanks for doing this!

Linking this issue because it's relevant: #2421

@tsmethurst
Copy link
Contributor

Alright, added a last couple suggestions, then I think this is good to go :)

@tsmethurst tsmethurst merged commit 403f5c0 into superseriousbusiness:main Feb 24, 2024
2 checks passed
@tsmethurst
Copy link
Contributor

Merged it! :) Thank you very much for this!

@fyrfli
Copy link
Contributor Author

fyrfli commented Feb 24, 2024

It was my pleasure! I love this project!

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.

[bug] Missing documentation of API authentication
4 participants