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

add npm package documentation to existing documentation #1312

Closed
awentzel opened this Issue Jan 17, 2019 · 0 comments

Comments

Projects
None yet
1 participant
@awentzel
Copy link
Member

awentzel commented Jan 17, 2019

This has been discussed with leadership and approved as an interim step moving towards our ideal solution. The ideal solution will take much longer and will be described in future proposal task. This gets us by for the foreseeable future.

What feature are you requesting?
We want to combine package documentation into the Docusaurus documentation.

What would be the benefit of adding this feature?
A single place where all documentation exists guide + api + marketing site

What solution would be ideal for you?
Described below

What alternatives have you considered?
Catalog, Gatsby, GitBook, Custom, etc

Is there any additional context for your request?
Yes. See below

Attach screenshots or images add detail to your request:
Included below in the requirements

Requirements
Write a package script that will execute a new process to copy each package readme.md into ./docs/en/packages/[package-name]/readme.md where Docusaurus expects markdown content files.

This image shows how things come together in Docusaurus land.
image

This should all be scripted with exception to the Docusaurus sidebars.json file.

  1. Script should be located as ./build/documentation/copy-package-readme.js
  2. Script will copy every package root readme. To ./docs/en/packages/[package-name]/
    a. Conditionally create folder if nonexistent matching the package name.
    b. Copy and replace if already existing from the ./packages/**/readme.md to ./docs/en/packages/[package-name]/
  3. Add the Docusaurus header as shown in the image lines 1-4. This will need to be created in code. Id will always be index. Title should be the package name as indicated by the package folder name. First word "FAST" all caps. Other words should be readable without hyphens. Sidebar_label: Should be the name without hyphens and without FAST.
    image
  4. Update Docusaurus navigation file located in /website/sidebars.json
    image
  5. Compile Docusaurus and ensure that these files are compiled along with our other documentation markdown files along with the appropriate navigation being rendered to the page. npm run build to compile any structural changes. npm run start to run the website.

@awentzel awentzel added this to the January 2019 milestone Jan 17, 2019

@awentzel awentzel self-assigned this Jan 17, 2019

@awentzel awentzel changed the title add npm package documentation to existing documentation add npm package documentation to existing documentation (approved) Jan 17, 2019

@awentzel awentzel changed the title add npm package documentation to existing documentation (approved) add npm package documentation to existing documentation Jan 17, 2019

@awentzel awentzel modified the milestones: January 2019, February 2019 Feb 13, 2019

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
You can’t perform that action at this time.