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

Update environment-setup.md #3762

Merged
merged 12 commits into from
Nov 20, 2022
Merged

Update environment-setup.md #3762

merged 12 commits into from
Nov 20, 2022

Conversation

P-DR0ZD
Copy link
Contributor

@P-DR0ZD P-DR0ZD commented Nov 16, 2022

Added some extra info to help prevent user errors

Issue This PR Addresses

Type of Change

  • Bugfix: Change which fixes an issue
  • New Feature: Change which adds functionality
  • Documentation Update: Change which improves documentation
  • UI: Change which improves UI

Description

Steps to test the PR

Checklist

  • Quality: This PR builds and passes our npm test and works locally
  • Tests: This PR includes thorough tests or an explanation of why it does not
  • Screenshots: This PR includes screenshots or GIFs of the changes made or an explanation of why it does not (if applicable)
  • Documentation: This PR includes updated/added documentation to user exposed functionality or configuration variables are added/changed or an explanation of why it does not(if applicable)

@gitpod-io
Copy link

gitpod-io bot commented Nov 16, 2022

@TueeNguyen
Copy link
Contributor

TueeNguyen commented Nov 16, 2022

Hey @P-DR0ZD, I'd recommend you to change these lines to the docs as it's more accurate to what we solved yesterday.

Change these

Stop the `parser` service running. If you have Docker app installed locally make sure to stop the `parser` container before continuing to the next step.
Finally, restart the `parser` container by running `pnpm:services start parser`.

to

Stop the `parser` service running. Make sure to stop the `parser` container before continuing to the next step by either using

Docker Desktop app:
![image](https://user-images.githubusercontent.com/58532267/202260945-30cc22f1-a634-4d4c-9d21-55824fd6bb5a.png)

Docker CLI: `docker stop <container-id>` (e.g, `15649f07c6bf` in above picture)

Switch to app's `.env` by `cp ./config/env.development ./.env` (you changed `.env` previously to seed database).

Finally, restart the `parser` container by running `pnpm:services start parser`. 

image

@manekenpix manekenpix added type: documentation (docs) Improvements or additions to documentation developer experience Helping the Developer Experience labels Nov 16, 2022
@humphd humphd requested a review from manekenpix November 17, 2022 23:38
Copy link
Member

@manekenpix manekenpix left a comment

Choose a reason for hiding this comment

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

This is almost ready, just one more change and I think it'll be good to go in.

  • I tested it and the build fails because the path to the image is wrong. It should be:
    ../../static/img/initialProjectDiagram.png (it's missing another ../).
    And since we're changing the path, can we give the image a different name? what's displaying is definitely not the "Initial Project Diagram".

Also, if you want to test your changes, go to the folder src/web/docusarus and run first pnpm build and then pnpm serve. After that, you should be able to access your local docusaurus in a browser.

@Genne23v
Copy link
Contributor

Thanks for this PR. I could set up my local to fix my issue based on this updated document. It's not relevant to this issue, but perhaps you could also update pnpm:services start parser to pnpm services:start parser in this PR.

Copy link
Member

@manekenpix manekenpix left a comment

Choose a reason for hiding this comment

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

Almost there, one other issue needs to be addressed (I mentioned it in another comment) and we're good here.

The issue:

And since we're changing the path, can we give the image a different name? what's displaying is definitely not the "Initial Project Diagram".

P-DR0ZD and others added 2 commits November 19, 2022 19:08
Added some extra info to help prevent user errors
Copy link
Member

@manekenpix manekenpix left a comment

Choose a reason for hiding this comment

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

LGTM 👍

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
developer experience Helping the Developer Experience type: documentation (docs) Improvements or additions to documentation
Projects
None yet
Development

Successfully merging this pull request may close these issues.

6 participants