-
Notifications
You must be signed in to change notification settings - Fork 19
Update developer portal documentation #33
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
base: main
Are you sure you want to change the base?
Changes from all commits
File filter
Filter by extension
Conversations
Jump to
Diff view
Diff view
There are no files selected for viewing
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -21,7 +21,7 @@ order: 1 | |
| --- | ||
|
|
||
| When an app is ready for publishing, the `.pbw` file needs to be uploaded to the | ||
| Pebble [Developer Portal]({{ site.links.devportal }}), where a listing is | ||
| Rebble [Developer Portal]({{ site.links.devportal }}), where a listing is | ||
| created. Depending on the type of app, different sets of additional resources | ||
| are required. These resources are then used to generate the listing pages | ||
| visible to potential users in the Pebble appstore, which is embedded within the Pebble mobile app. | ||
|
|
@@ -50,103 +50,69 @@ resources are before creating the listing. | |
|
|
||
| ## Publishing a Watchface | ||
|
|
||
| 1. After logging in, click 'Add a Watchface'. | ||
| 1. After logging in to the Developer Portal, click '+ New App'. Press 'Next'. | ||
|
|
||
| 2. Enter the basic details of the watchface, such as the title, source code URL, | ||
| and support email (if different from the one associated with this developer | ||
| account): | ||
| 2. Enter the basic details of the Watchface, such as the title, type, | ||
| and a description: | ||
|
|
||
|  | ||
|
|
||
| 3. Click 'Create' to be taken to the listing page. This page details the status | ||
| of the listing, including links to subpages, a preview of the public page, | ||
| and any missing information preventing release. | ||
| 3. Click 'Next' to be taken to the images page. Here you should upload screenshots for each platform your Watchface supports. | ||
|  | ||
|
Member
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. nit: do we need the |
||
|
|
||
|  | ||
| Further down the page is the option to upload a banner. During inital submission, you can provide one banner. After | ||
| your app is submitted, you will be able to provide up to 3 banners per platform if desired. Press 'Next'. | ||
|
|
||
| 4. The status now says 'Missing: At least one published release'. Click 'Add a | ||
| release' to upload the `.pbw`, optionally adding release notes: | ||
| 4. The next step is to optionally provide a website link and a source code link. Both fields can be left blank if desired. | ||
|
|
||
|  | ||
|  | ||
|
|
||
| 5. Click 'Save'. After reloading the page, make the release public by clicking | ||
| 'Publish' next to the release: | ||
| 5. Click 'Next'. The final page requires you to provide release notes for your first release, as well as the .pbw file. | ||
|
|
||
|  | ||
|  | ||
|
|
||
| 6. The status now says 'Missing: A complete X asset collection' for | ||
| each X supported platform. Click 'Manage Asset Collections', then click | ||
| 'Create' for a supported platform. | ||
|
|
||
| 7. Add a description, up to 5 screenshots, and optionally a marketing banner | ||
| before clicking 'Create Asset Collection'. | ||
|
|
||
|  | ||
|
|
||
| 8. Once all asset collections required have been created, click 'Publish' or | ||
| 'Publish Privately' to make the app available only to those viewing it | ||
| through the direct link. Note that once made public, an app cannot then be | ||
| made private. | ||
|
|
||
| 9. After publishing, reload the page to get the public appstore link for social | ||
| sharing, as well as a deep link that can be used to directly open the | ||
| appstore in the mobile app. | ||
| Once you have submitted this information, and you are happy with the submission, press 'Publish App to Store' to submit your app! | ||
|
|
||
|
|
||
| ## Publishing a Watchapp | ||
|
|
||
| 1. After logging in, click 'Add a Watchapp'. | ||
| 1. After logging in to the Developer Portal, click '+ New App'. Press 'Next'. | ||
|
|
||
| 2. Enter the basic details of the watchapp, such as the title, source code URL, | ||
| and support email (if different from the one associated with this developer | ||
| account): | ||
| 2. Enter the basic details of the App, such as the title, type, category and a description: | ||
|
|
||
|  | ||
|  | ||
|
|
||
| 3. Select the most appropriate category for the app, depending on the features | ||
| it provides: | ||
|
|
||
|  | ||
|
|
||
| 4. Upload the large and small icons representing the app: | ||
|
|
||
|  | ||
| 3. Click 'Next' to be taken to the images page. Here you should upload screenshots for each platform your App supports. | ||
|  | ||
|
|
||
| 5. Click 'Create' to be taken to the listing page. This page details the status | ||
| of the listing, including links to subpages, a preview of the public page, | ||
| and any missing information preventing release. | ||
| Further down the page is the section to upload a banner. During inital submission, you can provide one banner. After | ||
| your app is submitted, you will be able to provide up to 3 banners per platform if desired. | ||
|
|
||
|  | ||
| You must also provide a large icon and small icon for your Watch App. | ||
|
|
||
| 6. The status now says 'Missing: At least one published release'. Click 'Add a | ||
| release' to upload the `.pbw`, optionally adding release notes: | ||
|  | ||
|
|
||
|  | ||
| 4. The next step is to optionally provide a website link and a source code link. Both fields can be left blank if desired. | ||
|
|
||
| 7. Click 'Save'. After reloading the page, make the release public by clicking | ||
| 'Publish' next to the release: | ||
|  | ||
|
|
||
|  | ||
| 5. Click 'Next'. The final page requires you to provide release notes for your first release, as well as the .pbw file. | ||
|
|
||
| 8. The status now says 'Missing: A complete X asset collection' for | ||
| each X supported platform. Click 'Manage Asset Collections', then click | ||
| 'Create' for a supported platform. | ||
|  | ||
|
|
||
| 9. Add a description, up to 5 screenshots, optionally up to three header images, | ||
| and a marketing banner before clicking 'Create Asset Collection'. | ||
| Once you have submitted this information, and you are happy with the submission, press 'Publish App to Store' to submit your app! | ||
|
|
||
|  | ||
|
|
||
| 10. Once all asset collections required have been created, click 'Publish' or | ||
| 'Publish Privately' to make the app available only to those viewing it | ||
| through the direct link. | ||
|
|
||
| 11. After publishing, reload the page to get the public appstore link for social | ||
| sharing, as well as a deep link that can be used to directly open the | ||
| appstore in the mobile app. | ||
| ## Publishing a Companion App | ||
|
|
||
| <div class="alert alert--fg-white alert--bg-orange"> | ||
|
Member
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more.
Member
Author
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. This was a built in colour scheme from the docs. Shall we update the colour globally?
Member
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Hmmm, probably not, don't want to risk breaking something else. I've created #35 to track general accessibility stuff. For now I think we leave it as is, we can revisit later. |
||
| {% markdown %} | ||
| **Legacy Section** | ||
|
|
||
| ## Publishing a Companion App | ||
| The Rebble Developer Portal does not yet support companion apps. The legacy Pebble documentation is currently preserved here for reference. | ||
| If you wish to publish or update a companion app, please get in touch via [Discord]({{ site.links.discord_invite }}). | ||
| {% endmarkdown %} | ||
| </div> | ||
|
Comment on lines
+108
to
+115
Member
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Could we turn this "Legacy Section" into a reusable component? Seems useful for other parts of the docs too. Includes are probably the way to go here. |
||
|
|
||
| > A companion app is one that is written for Pebble, but exists on the Google | ||
| > Play store, or the Appstore. Adding it to the Pebble appstore allows users to | ||
|
|
||

There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Did you meant to comment this section out? Because they're just headings right now:
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Whoops. Yes I did