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 #2792 Set up Docusaurus website #2853

Merged
merged 2 commits into from
Feb 9, 2022

Conversation

cindyorangis
Copy link
Contributor

@cindyorangis cindyorangis commented Feb 6, 2022

Issue This PR Addresses

Fixes #2792
Fixes #2746
Fixes #290

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

This PR does the following:

  • adds Docusaurus to Telescope in the /src/docs directory.
  • adds eslint rules to .eslintrc.js
  • adds src/docs to pnpm-workspace in root
  • add appropriate files to .prettierignore

To test this PR locally:

  1. Add my repository as a remote: git remote add cindyledev https://github.com/cindyledev/telescope.git
  2. Fetch my branches: git fetch cindyledev
  3. Checkout my branch: git checkout issue-2792
  4. Install dependencies using pnpm in root (this will also install dependencies in src/docs: pnpm install
  5. Change directory to /src/docs: cd src/docs
  6. Start the server: pnpm start
  7. Visit localhost:4631 in browser

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 Feb 6, 2022

@cindyorangis
Copy link
Contributor Author

cindyorangis commented Feb 7, 2022

Requesting reviews from maintainers who have commented and reviewed the previous PR :) @humphd @JerryHue @aserputov @Kevan-Y @manekenpix

and @sirinoks because I know how much she loves docs

src/docs/README.md Outdated Show resolved Hide resolved
src/docs/package.json Outdated Show resolved Hide resolved
JerryHue
JerryHue previously approved these changes Feb 8, 2022
Copy link
Contributor

@JerryHue JerryHue left a comment

Choose a reason for hiding this comment

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

I'm excited for Docusaurus being set up and organize all the docs related issues we have!

Comment on lines +22 to +23
src/docs/package.json
src/docs/package-lock.json
Copy link
Contributor

Choose a reason for hiding this comment

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

I think these might be unnecessary, since we already have package.json and package-lock.json in the list, and the .gitignore rules are the same for .prettierignore.

This is more of a nitpick, so it might not even be necessary to change, just letting you know.

Kevan-Y
Kevan-Y previously approved these changes Feb 9, 2022
@Kevan-Y
Copy link
Contributor

Kevan-Y commented Feb 9, 2022

@cindyledev , created a follow-up issue to dockerize Docusaurus service. #2865

@JerryHue
Copy link
Contributor

JerryHue commented Feb 9, 2022

@cindyledev, we just need to rebase + squash the commits and we can merge this.

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.

Set up Docusaurus Create the Docs Microservice Convert our GitHub docs to MDX in Next.js
3 participants