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 development docs for new gatsby site #897

Merged
merged 1 commit into from
Oct 23, 2019
Merged

Conversation

emplums
Copy link
Contributor

@emplums emplums commented Sep 13, 2019

I noticed that the docs are out of date now that we've moved to doctocat! I've updated a few things.

@shawnbot I have a few questions!

  • Is storybook still the defacto way to work on new components or update an existing component? It seems like it's no longer functioning 😬. The main issue was that the folder we pointed to to grab markdown to turn into stories was incorrect, so I tried changing that, but now I'm getting this error:
WARNING in ./docs/content/utilities/index.md 1:2
Module parse failed: Assigning to rvalue (1:2)
You may need an appropriate loader to handle this file type.
> ---
| title: Utilities
| path: utilities/index

Not sure if it's the front matter specifically that's causing an issue or if we need to add a loader for md in general?

  • Is the test-urls script still relevant? If so I think we need to update that as well

I can make issues for these things if so!

/cc @primer/ds-core

@emplums emplums requested a review from shawnbot September 13, 2019 19:05
@vercel
Copy link

vercel bot commented Sep 13, 2019

This pull request is automatically deployed with Now.
To access deployments, click Details below or on the icon next to each push.

Latest deployment for this branch: https://primer-css-git-update-docs.primer.now.sh

@shawnbot shawnbot changed the base branch from master to release-13.2.0 October 22, 2019 18:54
Copy link
Contributor

@shawnbot shawnbot left a comment

Choose a reason for hiding this comment

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

@emplums thanks for this! I'd like to merge this soon and answer your questions:

  • Is storybook still the defacto way to work on new components or update an existing component? It seems like it's no longer functioning 😬.

Eek, yeah — let's file an issue for that. I think these days we're just using the docs site to test our components, so maybe Storybook isn't worth maintaining anymore?

  • Is the test-urls script still relevant? If so I think we need to update that as well

It's really only valid if we care about preserving redirects from the styleguide, which I think we still do. It does appear to still work, though, so I think we're good for now. When we do get around to shutting down the styleguide, we should probably refactor this test to ensure that we're not accidentally breaking any existing URLs, and we can do that by testing the paths that Gatsby exports.

This was referenced Oct 22, 2019
@shawnbot shawnbot merged commit e6e68e4 into release-13.2.0 Oct 23, 2019
@shawnbot shawnbot deleted the update-docs branch October 23, 2019 16:31
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants