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

Consider / plan a conversion to Gatsby (with spec-md as a plugin?) #7

Open
abernix opened this issue Apr 17, 2021 · 1 comment
Open

Comments

@abernix
Copy link
Member

abernix commented Apr 17, 2021

Follows-up on #6

Netlify and Gatsby is the predominant way we build sites at Apollo. While it has some shortcomings, our team is familiar with it and we should build on that (and have them fix the short-comings). That said, I find spec-md to be pretty great for what we're trying to represent here.

Strawdog/needs-full-plan: I think rather than generating the spec-md HTML via CLI, we could instead use its API's html method, perhaps coupled with a Gatsby source plugin like, but maybe not gatsby-source-plugin and a subsequent transformer.

@glasser
Copy link
Member

glasser commented Apr 18, 2021

Two bits of brainstorming about the structure of this repo:

  • Given that there's styling for specs that live in this repo but affect rendering of the other repos (eg anatomy.css), it might be nice for the sake of deploy previews to just merge the repos into one and put join and core in subdirectories
  • If we end up in a situation where we have a bunch of different versions of each spec to maintain, all of which may sometimes need to be updated in parallel for non-normative reasons (formatting/meta stuff, fixing typos, etc), and each of which are primarily just one file (plus a handful of images, examples, etc), it might be a lot more comfortable to have each version live in a subdirectory on main rather than on different branches, so that that kind of change can be handled in a single find-and-replace PR to all files in a tree rather than having to do a lot of merges across each versioned branch. (I think this is different from the "document a couple major versions of a library" case because we may end up with more versions to maintain of one page each, rather than a smaller number of major versions of a very large site.)

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

No branches or pull requests

2 participants