OpenFn / OpenFn/apollo

Auth: documentation on how to get started is too hard to find

Open Beginner friendly
#579 0 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Dominant language
Jupyter Notebook
Stars
5
Forks
10
Avg merge
2d 20h
Merged PRs (30d)
17

Description

When running apollo locally and calling it with curl or the CLI, no auth stuff is needed.

But if you're connecting a local lightning to your local apollo, you DO need to set up auth.

At the moment the instructions for auth are buried in platform/src/auth/readme.md which is just the worst place. It is linked to from teh readme, so that helps a bit.

But then - the auth docs are full of implementation detail about the hows and whys. The actual "here's how you get set up" bit is lost in a section called "the client CLI", which doesn't feel like the place I'd look for docs on how to configure my local platform.

So basically we need a redo on the docs, with basic setup steps clear and easy to find and follow.

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Start with platform/src/auth/readme.md and the README link to understand the current authentication guidance and where users are expected to find it. Reorganize the documentation so local platform authentication setup is clearly surfaced and easy to follow, while keeping implementation details separate; done means a user can readily find the setup steps for connecting local Lightning to local Apollo.

Written by the indexing model from the issue text.

Assessment

Domain
authentication, documentation
Issue type
Documentation
Difficulty
2/5
Estimated time
1-3 hours
Activity status
Quiet
Clarity
Mostly clear
Newbie friendliness
72/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.