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

Fixes #2369 Update environment setup documentation #2375

Merged
merged 8 commits into from
Oct 28, 2021

Conversation

cindyorangis
Copy link
Contributor

@cindyorangis cindyorangis commented Oct 21, 2021

Issue This PR Addresses

Closes #2369 Outdated environment setup documentation

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

I added a neat table of content at the top of our environment-setup because honestly, it was becoming hard to read and navigate. I also updated the instructions for some of the steps to reflect the new changes that were added so new and returning Telescope developers can get their environment up and running correctly.

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)

humphd
humphd previously approved these changes Oct 26, 2021
docs/environment-setup.md Outdated Show resolved Hide resolved
humphd
humphd previously approved these changes Oct 27, 2021
Copy link
Contributor

@humphd humphd left a comment

Choose a reason for hiding this comment

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

Really good, just one thing I think we should add.

docs/environment-setup.md Show resolved Hide resolved
Grommers00
Grommers00 previously approved these changes Oct 27, 2021
@humphd
Copy link
Contributor

humphd commented Oct 28, 2021

@cindyledev rebase, squash, and merge when ready! Thanks for doing this, it's awesome.

@cindyorangis
Copy link
Contributor Author

Thanks for the reviews! I will merge after the checks have passed

@cindyorangis cindyorangis changed the title Update environment setup documentation Fixes #2369 Update environment setup documentation Oct 28, 2021
@cindyorangis cindyorangis merged commit 207df8a into Seneca-CDOT:master Oct 28, 2021
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
hacktoberfest-accepted type: documentation (docs) Improvements or additions to documentation
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Outdated environment setup documentation
6 participants