Add documentation for custom plugins #137
Conversation
|
This pull request has been linked to Clubhouse Story #1486: Support Contenful's tech radar. |
|
@martina-if You know the build failed right? All good if so. 👍 |
martina-if
force-pushed
the
add-custom-plugin-docs
branch
from
c8346f1 to
008a9f3
Compare
There was a problem hiding this comment.
You'll need to manually edit the sidebar of the documentation to add a link to your page. Let's make a new section called "Advanced" in the sidebar and put this page in there.
https://github.com/RoadieHQ/marketing-site/blob/main/src/components/doc/Sidebar.js
The directory structure for this page of docs should then be content/docs/advanced/custom-plugins/index.md.
Also, this needs a rebase.
| 3. Build your plugin (e.g. yarn install && yarn tsc && yarn build) | ||
| 4. Publish your plugin npm publish | ||
| 5. (Optional) Check the registry npm info `@<your-company>-roadie/<package-name>` | ||
|
|
There was a problem hiding this comment.
Is there a way to verify that everything worked or something we can tell the user to do as a next step? It feels kinda inconclusive down here.
There was a problem hiding this comment.
AFAIK we don't have anything for that yet. I added this story to the custom plugin epic https://app.clubhouse.io/larder/story/1571/give-user-feedback-on-publishing-operation
This is for the old way of adding a custom plugin so we should decide if we want to build that or just add the feedback in the new way of adding custom plugins. I will ask Iain anyways in case I missed something.
There was a problem hiding this comment.
Perhaps we could explain how we will notify them when their custom plugin shows up?
It might also be worth saying that future updates to the plugin won't require re-submission of the form or manual steps and thus should be must faster.
There was a problem hiding this comment.
Not sure what you mean by this
Perhaps we could explain how we will notify them when their custom plugin shows up?
We can't see when it shows up. Should we say, we will notify them on slack when the first build is ready?
I will add now the second part you mention
There was a problem hiding this comment.
Yeah exactly. We haven't told them what happens after they submit the Google form, so they won't know when the plugin is installed and ready to use. We should tell them that we will notify them via their shared Slack channel or via email when the plugin is ready to use after being installed the first time.
There was a problem hiding this comment.
Added some comments to the prerequisites, and the end of the file. Let me know what you think about those
martina-if
force-pushed
the
add-custom-plugin-docs
branch
from
008a9f3 to
eda4a04
Compare
|
This pull request has been linked to Clubhouse Story #1422: Change documentation links in the Backstage code. |
| 3. Build your plugin (e.g. yarn install && yarn tsc && yarn build) | ||
| 4. Publish your plugin npm publish | ||
| 5. (Optional) Check the registry npm info `@<your-company>-roadie/<package-name>` | ||
|
|
There was a problem hiding this comment.
Perhaps we could explain how we will notify them when their custom plugin shows up?
It might also be worth saying that future updates to the plugin won't require re-submission of the form or manual steps and thus should be must faster.
|
I added the conclusion section but it feels like the wrong word for this. Perhaps "next steps" or "what to expect next" or something similar would be better. |
|
The |
martina-if
force-pushed
the
add-custom-plugin-docs
branch
from
1b986d9 to
9ee9d79
Compare
[Ch1422]
Is this the right place in the sidebar?