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.

Sign up for GitHub

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

Jump to bottom

Add Algolia notes to Plugin Authoring doc #4673

Closed
3 tasks
shannonbux opened this issue Mar 23, 2018 · 5 comments · Fixed by #7733
Closed
3 tasks

Add Algolia notes to Plugin Authoring doc #4673

shannonbux opened this issue Mar 23, 2018 · 5 comments · Fixed by #7733
Assignees
@shannonbux
Labels
help wanted Issue with a clear description that the community can help with. type: documentation An issue or pull request for improving or updating Gatsby's documentation

Comments

@shannonbux
Copy link
Contributor

  • Add instructions to the page for plugin authors about how to get their plugin to show up — namely
    • add "gatsby-plugin" as keyword
    • wait 24 hours while Algolia reindexes
@shannonbux shannonbux added the type: documentation An issue or pull request for improving or updating Gatsby's documentation label Mar 23, 2018
@shannonbux shannonbux mentioned this issue Mar 23, 2018
Closed
16 tasks
@KyleAMathews
Copy link
Contributor

I think I said at some point it was 24 hours but I most have made that up as I'm not sure the reindex time is documented and in practice, it seems Algolia updates very quickly after a new publish to NPM.

@jlengstorf jlengstorf removed their assignment Jun 9, 2018
@jlengstorf jlengstorf added the help wanted Issue with a clear description that the community can help with. label Jun 9, 2018
@shannonbux shannonbux self-assigned this Jul 20, 2018
@hdoro
Copy link
Contributor

hdoro commented Aug 23, 2018

Hey there :)

So, when I published gatsby-source-sanity I was a bit anxious to see it in the docs, so I went straight to https://gatsbyjs.org and https://next gatsbyjs.org, and in both I could see the result from algolia but the page wasn't built yet, so it returned a 404...

It took from 12 to 30 hours for the page to show up (sorry for the broad range), I believe that's because you have a daily routine to check algolia and rebuild the website?

Anywho, it seems like algolia is the faster side here. I'd be glad to do a PR with this tiny addition to the plugin authoring docs ;)

@jlengstorf
Copy link
Contributor

@hcavalieri we'd absolutely love to have you update the docs! Thanks so much! 💪💜

@hdoro
Copy link
Contributor

hdoro commented Aug 28, 2018

Hey there, @jlengstorf , how's it going? So, 4 days ago I forked the repo and added this change for the docs but it doesn't seem to have been submitted as a PR... sorry for the silly question, but any suggestions?

@jlengstorf
Copy link
Contributor

Hey, @hcavalieri!

Now that you've made the changes, you'll need to open a pull request as well. This should help you get started: master...hcavalieri:patch-1

Let me know if you have any questions!

@hdoro hdoro mentioned this issue Aug 29, 2018
Merged
m-allanson pushed a commit that referenced this issue Aug 31, 2018
@hdoro @m-allanson
[docs] Plugin Authoring doc: publishing info (#7733)
965b51e 
* Plugin Authoring doc: publishing info

I've added a couple of paragraphs under a new H2 for _Publishing a plugin to the library_ to help with #4673 .

Instead of just adding a tiny note on how much time Algolia would take to add the page to the library, based on my previous experience, I thought it was best to create a new section on publishing as it could be a bit confusing for beginners (in the very least, it was for me). The wording is still probably a bit off, feel free to suggest changes 😄 

**PS:** In the first section of this page we say we'll review "what a plugin is _not_", but I don't this in any explicit way here... what was your line of thought in including this?

* Removing "simply" and going from "NPM" to "npm"

* Remove title for missing section
@snyk-bot snyk-bot mentioned this issue Aug 16, 2021
Open
This was referenced Oct 2, 2023
Open
Open
@Rutam21 Rutam21 mentioned this issue Oct 2, 2023
Open
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees

@shannonbux shannonbux

Labels
help wanted Issue with a clear description that the community can help with. type: documentation An issue or pull request for improving or updating Gatsby's documentation
Projects
None yet
Milestone
No milestone
Development

Successfully merging a pull request may close this issue.

[docs] Plugin Authoring doc: publishing info
4 participants
@KyleAMathews @jlengstorf @hdoro @shannonbux