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

docs: Bring/Setup documentation deployment for Federation from Server repo. #158

Merged
merged 2 commits into from
Sep 17, 2020

Conversation

abernix
Copy link
Member

@abernix abernix commented Sep 16, 2020

This brings the existing documentation and its supporting infrastructure (in
this case, modeled after/copied from the Apollo Server repository, but this
is standard "Apollo infrastructure" in the general sense) to the Federation
repository where it can live alongside the code that was migrated over in
#134.

Next Steps

⚠️ Each of these blocks the next, but neither of them blocks this PR from merging now as merging it would not result in the documentation becoming available in any linked-sense anywhere.

Related: #142
Related: #143

(Both of these will close when the TODOs are completed).

This brings the existing documentation and its supporting infrastructure (in
this case, modeled after the Apollo Server repository, but this is standard
"Apollo infrastructure" in the general sense) to the Federation repository
where it can live alongside the code that was migrated over in
#134.

Related: #142
Related: #143
@abernix
Copy link
Member Author

abernix commented Sep 16, 2020

@trevorblades Although apollo-server sets its Netlify base as docs/ and its publish directory as docs/public, that precise configuration over here (with what I believe is 100% the same structure) resulted in an Error cannot find /docs/docs/public.

Therefore, I had to introduce f69888a to this PR to make it build.

To be honest, having publish be relative to base makes a lot of sense to me — and that's exactly what the Netlify documentation suggests is the case — so I'm actually more surprised that apollo-server is requiring that treatment and happy that this makes sense, but it's odd that they're different. Perhaps Apollo Server's setup is grandfathered into a mode that requires relativity to the netlify.toml? Anyhow, just worth mentioning, and soliciting your perspective, not looking for anything to be changed necessarily (unless I'm doing something wrong!)

Enrico2 pushed a commit that referenced this pull request Sep 16, 2020
Clarify in our README what each badge stands for, and add a netlify badge (which will stop failing once #158 is merged)

closes #149
@trevorblades
Copy link
Contributor

@abernix looks good to me! Regarding the relativity of the publish property in netlify.toml, I think you're right:

Perhaps Apollo Server's setup is grandfathered into a mode that requires relativity to the netlify.toml?

Tbh, reading the Netlify docs on this subject make me question how the other docs sites are working with their current configs, but I remember looking into this before, and coming to the same conclusion then. 🤷‍♂️

I'll coordinate with @StephenBarlow to get an update to the docset switcher into the docs theme 👍

@abernix
Copy link
Member Author

abernix commented Sep 17, 2020

Tbh, reading the Netlify docs on this subject make me question how the other docs sites are working with their current configs, but I remember looking into this before, and coming to the same conclusion then. 🤷‍♂️

@trevorblades Same.

I'll coordinate with @StephenBarlow to get an update to the docset switcher into the docs theme 👍

Thank you so much, to you both, in advance!

@abernix abernix merged commit 8b5ebc6 into main Sep 17, 2020
@abernix abernix deleted the abernix/add-docs branch September 17, 2020 09:59
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