` dir
AbandonedPublic
Actions

Authored by ashoat on Feb 23 2022, 4:52 PM.

Details

Reviewers

atul
varun
• anand

Summary

This diff introduces Docusaurus as scaffolding to host docs on a static website. The project is open source and is built with React.

Changes made in this diff:

Addition of scaffolding, minus node_modules and build folders
- README.md contains commands of use. yarn installs deps, yarn start runs a development server, and yarn build compiles a build folder with the static files.

The docs themselves have been separated into pages. dev_environment.md has been divided into Requirements, Prerequisites, Configuration, and Development sections respectively.
- Admonitions (tips, cautions, notes, warnings) have been added which deviate from regular markdown syntax. They are denoted by three leading colons (example is :::note.
- Sidebars are provided to navigate through pages and sections.
- Toggles reduce redundancy between x86 / Apple silicon instructions, and the setting persists, barring full page reload.

I have not removed the existing dev_environment.md and linux_dev_envirinment.md files in this diff. That will be done in a subsequent diff.

Test Plan

yarn run serve -- --build --port 80 --host 0.0.0.0 (or some other port) for production build. Also tested with yarn run for dev build. Deployment is currently on my github at www.andnasnd.github.io

I am unsure how to break this diff into smaller components. A lot of this is scaffolding, although I removed a bunch of fluff boilerplate and modified the routing, css styling, icons, and markdown content.

Diff Detail

Repository

rCOMM Comm

Branch

lastday

Lint

No Lint Coverage

Unit

No Test Coverage

Event Timeline

• anand created this revision.Feb 23 2022, 4:52 PM

Herald added subscribers: • karol, • adrian, tomek, ashoat. · View Herald TranscriptFeb 23 2022, 4:52 PM

Harbormaster completed remote builds in B6993: Diff 9863.Feb 23 2022, 4:59 PM

• anand requested review of this revision.Feb 23 2022, 4:59 PM

• anand edited the test plan for this revision. (Show Details)Feb 23 2022, 4:59 PM

• anand edited the summary of this revision. (Show Details)Feb 23 2022, 5:01 PM

• anand edited the test plan for this revision. (Show Details)

Updating D3277. Including .docusaurus folder and removing some template icons.

Harbormaster completed remote builds in B6995: Diff 9865.Feb 23 2022, 5:09 PM

atul added reviewers: • benschac, varun.Feb 24 2022, 9:30 AM

It looks like the .docusaurus directory has a bunch of output that's been generated from the provided markdown... which makes this hard to review.

Is the goal to include the sources needed to generate the static site? Or to include the source and the generated static site in the repo?

My preference would be to just check in the source, and then "build" and deploy via GitHub Actions or something.

I think this definitely could have been broken down further. We could have done something loosely like:

Add the "starter" docusaurus hello world template to the docs workspace
Modify the package.json file so we can use the same yarn dev, yarn prod, yarn build etc patterns that we use in the other workspaces
Include Comm-specific docs in a naive way (sans Admonitions and whatnot)
Figure out how to build and deploy via GitHub Actions
Refactor the docs following the docusaurus idioms or whatever (eg add the admonitions)

etc..

This revision now requires changes to proceed.Feb 24 2022, 10:21 AM

• benschac removed a reviewer: • benschac.Mar 9 2022, 10:32 AM

Herald added a subscriber: • benschac. · View Herald TranscriptMar 9 2022, 10:32 AM

removing myself from review here. I wasn't a part of any of the initial review. Feel free to add me if you think I should still be a reviewer.