Skip to content

Commit 523b375

Browse files
committed
docs: update registration with attributes requirement
1 parent d179e9c commit 523b375

File tree

1 file changed

+15
-2
lines changed

1 file changed

+15
-2
lines changed

help/registering/index.md

+15-2
Original file line numberDiff line numberDiff line change
@@ -174,6 +174,14 @@ If all is in the green, follow these steps:
174174
#python: ">=2.7,<3" # Python 2 & 3
175175
#python: ">=3,<4" # Python 3 only
176176

177+
# TODO
178+
# If any of the below attributes apply to your project, uncomment the corresponding lines. This is MANDATORY!
179+
180+
attributes:
181+
# - cloud # if your plugin requires access to a cloud to function
182+
# - commercial # if your plugin has a commercial aspect to it
183+
# - free-tier # if your plugin has a free tier
184+
177185
---
178186

179187
Longer description of your plugin, configuration examples etc. This part will be visible on the page at
@@ -233,8 +241,13 @@ If all is in the green, follow these steps:
233241
to ``<project url>/archive/your_branch.zip`` (``master``, ``main`` are commonly used as branch name) adjust your
234242
branching strategy to **only** have latest release there.
235243

236-
If you are unsure about how something should be structured take a look at the existing plugins or
237-
[ask on the forum](https://community.octoprint.org/c/development).
244+
* If your plugin **requires a cloud to function, has a commercial aspect to it and/or has a free tier** you *must*
245+
mark it as such using the ``attributes`` property. If you are unsure about whether your plugin qualifies as being
246+
commercial, ask for clarification on that in your registration pull request. Please note that commercial plugins are
247+
excluded from the public stats after some cases of manipulation.
248+
249+
If you are unsure about how something should be structured, take a look at the existing plugins or
250+
[ask on the forum](https://community.octoprint.org/c/development) or in your registration pull request.
238251

239252
4. Ideally, you'll test that your plugin gets listed correctly and the plugin page looks
240253
as expected. For this you'll need to install [Jekyll](http://jekyllrb.com/), which is what [Github Pages](https://pages.github.com/) and hence

0 commit comments

Comments
 (0)