chore: Improve builder-server documentation#792
Conversation
cyaiox
force-pushed
the
chore/add-documentation
branch
from
0ea4885 to
7f6714a
Compare
Pull Request Test Coverage Report for Build 20576242409Details
💛 - Coveralls |
![github-advanced-security[bot]](https://avatars.githubusercontent.com/in/57789?s=60&v=4){kind=small}
LautaroPetaccio
left a comment
LautaroPetaccio
left a comment
There was a problem hiding this comment.
LGTM! 👍 I've left a couple of comments to review
README.md
Outdated
| - **[Catalyst](https://github.com/decentraland/catalyst)**: Content server for deployed scenes and wearables | ||
| - **[Subgraph APIs](https://subgraph.decentraland.org)**: Blockchain data for collections, items, and third parties | ||
|
|
||
| External dependencies: |
There was a problem hiding this comment.
WDYT about not differentiating between external an "internal" dependencies?
README.md
Outdated
| ``` | ||
|
|
||
| First, run all services simultaneously with: | ||
| Key environment variables: |
There was a problem hiding this comment.
Would you mind creating a .default.env with all the required variables to run the service and removing this section so there's a single place where all of them live? Would you also mind to adding comments to these variabrles as they're described here in the description column?
There was a problem hiding this comment.
we already have the .env.example file with the default values to run the service. I'll update it with the comments
README.md
Outdated
| #### Windows Subsystem for Linux (WSL) | ||
|
|
||
| If using WSL, start PostgreSQL service before running: | ||
|
|
||
| ```bash | ||
| sudo service postgresql start | ||
| ``` |
There was a problem hiding this comment.
WDYT about removing this section as it's related to using PostgreSQL?
4 participants
This PR improves the current builder-server documentation, enhancing the README.md and adding the database schema definitions.