DOCS: RefactorREADME.md to make it crisp and readable
#5100
Conversation
|
great PR harsh! here are a few thoughts: i appreciated that you saved all of the README content, but TBH i think we can remove all of it. we have all the content at docs.localstack.cloud now. i made sure the README content was transferred when we did the swarming. InstallingI know this was not part of your PR, but maybe we could add it to the scope. I think we could rephrase the story a bit. "The easiest way to install LocalStack is via pip" is misleading in my opinion, as localstack is not really being installed, it's actually the localstack-cli that's installed that then runs the docker image which contains the localstack runtime. Running
|
|
also, what if we move the contributors into a subreadme into docs/community? we could extend that section later with more infos about the community |
Yes, I did that first but later reverted those changes in the next commit. It is always a good idea to have contributors on the main |
i don't have a super strong opinion on this. i trust your judgement :-) |
this looks much much cleaner! couple more things then i think it's ready to merge
- leave at least one example to run localstack with the CLI (see inline comment)
- i think we can remove the stargazers over time to be honest. it's not really helpful, we can maybe make it part of the community subpage
- i think we can remove all the other README pages in the docs/ folder that we already have at docs.localstack.cloud. so
docs/interaction/docs/developer_guides,docs/advanced_topicsetc..
|
|
||
| ## Running | ||
|
|
||
| By default, LocalStack is started inside a Docker container by running: |
There was a problem hiding this comment.
i think it makes sense to leave one example to start localstack via the cli, and maybe tease some of the experience that the person will have
something like
% localstack start -d
__ _______ __ __
/ / ____ _________ _/ / ___// /_____ ______/ /__
/ / / __ \/ ___/ __ `/ /\__ \/ __/ __ `/ ___/ //_/
/ /___/ /_/ / /__/ /_/ / /___/ / /_/ /_/ / /__/ ,<
/_____/\____/\___/\__,_/_//____/\__/\__,_/\___/_/|_|
💻 LocalStack CLI 0.13.1
[20:22:20] starting LocalStack in Docker mode 🐳
[20:22:21] detaching
which will download and start the localstack docker container
you can query the state with:
% localstack status
┏━━━━━━━━━━━━━━━━━┳━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┓
┃ Runtime version ┃ 0.13.0.10 ┃
│ Docker image │ tag: latest, id: 41d3a94e8776, 📆 2021-12-05T15:37:01 │
│ Runtime status │ ✔ running (name: "localstack_main", IP: 172.17.0.2) │
└─────────────────┴───────────────────────────────────────────────────────┘
or
% localstack status services
┏━━━━━━━━━━━━━━━━━━━━━━━━━━┳━━━━━━━━━━━━━┓
┃ Service ┃ Status ┃
┡━━━━━━━━━━━━━━━━━━━━━━━━━━╇━━━━━━━━━━━━━┩
│ acm │ ✔ available │
│ apigateway │ ✔ available │
│ cloudformation │ ✔ available │
│ cloudwatch │ ✔ available │
│ config │ ✔ available │
│ dynamodb │ ✔ available │
...
There was a problem hiding this comment.
I have created an Example section to exactly serve this purpose.
|
Awesome, great to see this merged @HarshCasper @thrau - so much cleaner, and now we don't need to maintain the configuration docs in two places. On that note, looks like a few smaller changes did not make it from the README to our docs yet (e.g., |
Description
This PR: