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 official integration READMEs to docs #954

Merged
merged 54 commits into from
Jul 11, 2022
Merged

Conversation

delucis
Copy link
Member

@delucis delucis commented Jul 8, 2022

What kind of changes does this PR include?

  • New or updated content
  • Changes to the docs site code

Description

To do
  • Think about what we want these pages to look like.
    • Are we really fans of <details>?
    • What’s missing on these auto-generated pages?
    • Is there anything we want to remove?
    • Do we want to make changes to the actual READMEs now we’re seeing them in this context?
  • Make the integrations navigation component pretty à la deploy guide
  • Make an integration page layout to include the nav component in the footer like for deploy guides
  • Add a remark plugin to map video URLs to video embeds (see Add official integration READMEs to docs #954 (comment))
  • Fix absolute links when using the footnote/reference/whatever it's called format
  • Remove table of contents as we have that in “On this page”. Do we need to tag these specially in the integration READMEs? A hide-in-docs class or something? Done by assuming all of these start with a link to #why...
  • Add complete Changelog sections to the actual READMEs
  • Do a pass for weird formatting differences (Astro is fussier than GitHub at Markdown rendering)
  • Add <details> styling
  • Add package info to header (latest version, npm link, etc.)
  • Fix current sidebar item highlighting for integration pages

@delucis delucis added add new content Document something that is not in docs. May require testing, confirmation, or affect other pages. site improvement Some thing that improves the website functionality - ask @delucis for help! ci Automated PRs created by CI, or PRs about automation - ask @delucis for help! labels Jul 8, 2022
@netlify
Copy link

netlify bot commented Jul 8, 2022

Deploy Preview for astro-docs-2 ready!

Name Link
🔨 Latest commit c30cf9a
🔍 Latest deploy log https://app.netlify.com/sites/astro-docs-2/deploys/62cc746d288fb50008dee2a4
😎 Deploy Preview https://deploy-preview-954--astro-docs-2.netlify.app
📱 Preview on mobile
Toggle QR Code...

QR Code

Use your smartphone camera to open QR code link.

To edit notification comments on pull requests, go to your Netlify site settings.

@sarah11918

This comment was marked as resolved.

@sarah11918

This comment was marked as resolved.

@sarah11918
Copy link
Member

Are we fans of details?

We LOVE details, as a concept. 💜

I know we originally wondered, "Should INSTALL instructions be hidden behind details? Isn't that kind of a DON'T HIDE thing?"

At the time, it was possible to install these integrations through create-astro and I think it was common that you'd often know upfront if you wanted e.g. Tailwind. So, even astro add wasn't THAT big a thing to surface. Maybe now that everyone will have to astro add, it shold be plastered more prominently? Or, I could see the opposite argument. If ALL these things can be astro added, then it's gonna say that clearly on the main integrations page, a user may very well be astro adding a bunch of stuff, and the command will be a bit more common knowledge anyway.

I'm going to say loud +1 on detailing away at the very least manual install instructions. We shouldn't really need them soon (and at least in tailwind doc, astro add is still mentioned as "experimental" so that can change any time.) That's all I have a definite opinion about right now.

@sarah11918
Copy link
Member

Adding a note to remind us to check on all these install instructions now that there have been changes to create-astro and astro-add. E.g. Is this still relevant?
image

@delucis delucis marked this pull request as ready for review July 10, 2022 17:44
@sarah11918
Copy link
Member

sarah11918 commented Jul 11, 2022

@delucis This looks fantastic!

Now that we have all this, I think at a minimum, here are some quick changes to make to the main Integrations page in docs:

  • Remove the React tutorial entirely. Now that astro add is stable for all the official integrations, AND it links to every single set of READMEs with installation instructions there, I don't think this page needs to show an example of the long method.
  • Re the EXPERIMENTAL note:
    1. Swap the order of the 2 paragraphs inside the note. It's really only 3rd party that are experimental, so let's highlight THAT, and make the follow up text that official integrations are fine and totally supported
    2. Move the note down lower, maybe right before Using Integrations? But definitely lower.
  • The Automatic Integration Setup needs to be slightly redrafted to remove reference to:
    1. being experimental
    2. "instead of the manual install intstructions above"
    3. I think we'll find this can be streamlined in general now, but at least those 2 things will stand out
  • Handling Peer depenencies: I almost don't even want this here anymore? I think it's big and it's distracting. Wild idea: this gets moved into troublshooting. Less wild idea: this text is streamlined, maybe even into a note. I just don't think it's as big an issue anymore to take up so much real estate, especially before even getting to "Using Integrations." We could simply comment it out for now, and I can slowly rewrite and bring it back in in some form.

@sarah11918
Copy link
Member

@delucis All these changes LGTM! There is one failing test I've been chatting to @hippotastic about, but we think it's non-blocking.

This is all yours when you're happy!

@delucis delucis changed the title [WIP] Add official integration READMEs to docs Add official integration READMEs to docs Jul 11, 2022
Copy link
Contributor

@tony-sull tony-sull left a comment

Choose a reason for hiding this comment

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

Very cool! Looks great, added a few FYI notes along the way but nothing blocking a merge

Can't wait to see these pages live!

You can find many integrations developed by the community in the [Astro Integrations Directory](https://astro.build/integrations/). Follow links there for detailed usage and configuration instructions.

:::note[Experimental status]
**To enable third-party integrations:** Run Astro with the `--experimental-integrations` CLI flag, or include `experimental: { integrations: true }` in your Astro config file.
Copy link
Contributor

Choose a reason for hiding this comment

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

May already be tracked elsewhere, but I'm pretty sure we'll be getting rid of the experimental flag as part of the 1.0 release candidate

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
add new content Document something that is not in docs. May require testing, confirmation, or affect other pages. ci Automated PRs created by CI, or PRs about automation - ask @delucis for help! site improvement Some thing that improves the website functionality - ask @delucis for help!
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Automatically include integration READMEs on docs site
3 participants