Quickstart guide does not contain sign up and login steps
Nobody has claimed this yet.
- Dominant language
- Python
- Stars
- 1.9k
- Forks
- 323
- Avg merge
- 1d 12h
- Merged PRs (30d)
- 12
Description
Describe the bug
The Quickstart guide https://mlco2.github.io/codecarbon/usage.html has a video. The video shows a user typing codecarbon config and then the user enters some other details but locally I get asked for login details which are not in the Quickstart guide
To Reproduce
Steps to reproduce the behavior:
- Go to https://mlco2.github.io/codecarbon/usage.html
- Follow instructions
- In terminal type
codecarbon config - Enter path for config file
- Enter API endpoint (press enter to use default)
- Get error for login
- use
http://localhost:8008instead like the video - Observe same error
Expected behavior
Entering the same as the quickstart video provides same result
Quickstart includes info on how to overcome login issue
Unfortunately I also am having problems signing up which I have raised a separate bug for so I can't progress even without doing a login
Contributor guide
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
Start with the Quickstart guide at https://mlco2.github.io/codecarbon/usage.html and reproduce the codecarbon config flow using the documented endpoint and http://localhost:8008. Confirm the login and sign-up behavior, then update the Quickstart with the missing steps and verify that its instructions match the video and a successful configuration flow.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- python
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 2/5
- Estimated time
- 1-3 hours
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 45/100