Commit Graph

74 Commits

Author SHA1 Message Date
Felipe Cruz Martinez ac8d5c7953
Update Extensions SDK API ref with `viewContainerTerminal` (#16608)
* Update Extensions SDK API ref with viewContainerTerminal

* Add since 0.3.4
2023-02-27 16:15:55 +00:00
Benjamin Grandfond 850fde24e2
Update extension publishing process (#16592)
* Add validate page in the toc as it was missing

* Update publishing process

Introduce self-published and docker reviewd notions

Apply suggestions from code review

Co-authored-by: Allie Sadler <102604716+aevesdocker@users.noreply.github.com>
Co-authored-by: Felipe Cruz Martinez <15997951+felipecruz91@users.noreply.github.com>

* Add cards for publishing option to make them more visible

* Add images on cards

* Add description on the cards

* Mention self-published extension in the end users docs page as well

* Use buttons rather than cards

* Apply suggestions from code review

* Update desktop/extensions-sdk/extensions/publish.md

---------

Co-authored-by: Allie Sadler <102604716+aevesdocker@users.noreply.github.com>
Co-authored-by: Felipe Cruz Martinez <15997951+felipecruz91@users.noreply.github.com>
2023-02-27 16:15:43 +00:00
Benjamin Grandfond c4aaf47add
Update extension publishers' feedback form link (#16637)
* Change the feedback form link

* Move the extension security page under the architecture section
2023-01-31 14:57:41 +00:00
Benjamin Grandfond 0581887342
Remove extra double quotes (#16611) 2023-01-27 17:11:56 +00:00
Benjamin Grandfond 6dbc5156e7
Fix wrong port number since vite migration 2023-01-27 11:06:53 +01:00
Allie Sadler 790a5c2a37
ENGDOCS-1184 (#16555) 2023-01-19 12:50:19 +00:00
Guillaume Tardif cd58a17552
Update generated reference docs with extension API 0.3.3 (Desktop 4.16) (#16520)
Signed-off-by: Guillaume Tardif <guillaume.tardif@gmail.com>

Signed-off-by: Guillaume Tardif <guillaume.tardif@gmail.com>
2023-01-18 09:16:20 +00:00
Guillaume Tardif fe91aafd89
Minor extension docs improvement (#16516)
* Minor extension docs improvement

Signed-off-by: Guillaume Tardif <guillaume.tardif@gmail.com>

* Apply suggestions from code review

Co-authored-by: Lucas Bernalte <lucas.bernalte@gmail.com>

* Update desktop/extensions-sdk/build/frontend-extension-tutorial.md

Co-authored-by: Allie Sadler <102604716+aevesdocker@users.noreply.github.com>

Signed-off-by: Guillaume Tardif <guillaume.tardif@gmail.com>
Co-authored-by: Lucas Bernalte <lucas.bernalte@gmail.com>
Co-authored-by: Allie Sadler <102604716+aevesdocker@users.noreply.github.com>
2023-01-13 13:55:51 +00:00
Guillaume Tardif 8a4f8eb776
Removed remaining ref to backend service in oauth flow doc (#16515)
Signed-off-by: Guillaume Tardif <guillaume.tardif@gmail.com>

Signed-off-by: Guillaume Tardif <guillaume.tardif@gmail.com>
2023-01-13 11:44:08 +00:00
Guillaume Tardif 4782aa4915
Clarify security extension trust model, and move UI specific section in front-end code tutorial (#16511)
Signed-off-by: Guillaume Tardif <guillaume.tardif@gmail.com>

Signed-off-by: Guillaume Tardif <guillaume.tardif@gmail.com>
2023-01-13 10:21:18 +00:00
Guillaume Tardif 7b72d8c377
Document the extension OAuth required API version to 0.3.3, corresponding to Desktop 4.16 (#16510)
0.3.2 was an internal API version bump, it does work but people might ask why using this and the effective API version seen with Desktop public release is 0.3.3.

Signed-off-by: Guillaume Tardif <guillaume.tardif@gmail.com>

Signed-off-by: Guillaume Tardif <guillaume.tardif@gmail.com>
2023-01-13 08:53:28 +00:00
Allie Sadler a37a50eb17
Dd4.16 content (#16497)
* add rosetta beta feature

* Change mac preferences to settings

* updates to the images view

* add info about quick search

* image fix

* image-fix

* Typo fix
2023-01-12 15:29:37 +00:00
Guillaume Tardif 635e0160e3
Remove extension beta mentions (#16383)
Signed-off-by: Guillaume Tardif <guillaume.tardif@gmail.com>

Signed-off-by: Guillaume Tardif <guillaume.tardif@gmail.com>
2023-01-12 15:29:19 +00:00
Guillaume Tardif e74dd9e578
Update extension OAuth docs with ability to redirect to the extension with query params (#16391)
Signed-off-by: Guillaume Tardif <guillaume.tardif@gmail.com>

Signed-off-by: Guillaume Tardif <guillaume.tardif@gmail.com>
2023-01-12 15:29:09 +00:00
Matthew Davis eddd4bfc33
remove redundant image with case-insensitive name-clash (#16482) 2023-01-11 08:47:43 +00:00
Allie Sadler f956ab6552
Improve alt text on images (#16484) 2023-01-10 16:28:46 +00:00
Allie Sadler d1bbdaff4b
SDK form (#16456)
* SDK form

* implement feedback

* code review

* make callout more readable
2023-01-09 14:31:19 +00:00
Benjamin Grandfond ee8a6b745e
Add redirect (#16326)
* Add redirect

* Move the overview and top and rename the file to index.md
2023-01-03 16:15:23 +00:00
Felipe Cruz Martinez 648bd120d6
Add extensions security doc (#16389)
* Add extensions security doc

* Apply suggestions from code review

Co-authored-by: Guillaume Tardif <guillaume.tardif@gmail.com>

* fixes review comments

Signed-off-by: Guillaume Tardif <guillaume.tardif@gmail.com>

Signed-off-by: Guillaume Tardif <guillaume.tardif@gmail.com>
Co-authored-by: Guillaume Tardif <guillaume.tardif@gmail.com>
2023-01-03 10:03:57 +00:00
Usha Mandya a6c6a1fa8d
Merge pull request #16409 from scraly/patch-3
fix: the App.tsx example file content
2022-12-29 10:48:20 +00:00
Aurelie Vache a821761ebf
fix: the App.tsx example file content 2022-12-28 11:53:43 +01:00
Aurelie Vache a151debaf1
fix: the dockerfile example 2022-12-27 20:04:07 +01:00
Guillaume Tardif ebf7272b2d
Update info about extension local storage and tokens (#16390)
Signed-off-by: Guillaume Tardif <guillaume.tardif@gmail.com>

Signed-off-by: Guillaume Tardif <guillaume.tardif@gmail.com>
2022-12-21 13:09:03 +00:00
Benjamin Grandfond a137f93a62
Extract the validate section and remove build/install page
Co-authored-by: David Karlsson <35727626+dvdksn@users.noreply.github.com>
2022-12-19 17:30:29 +01:00
Usha Mandya df88d8451a
Merge pull request #16289 from benja-M-1/extension/architecture
Add extensions architecture section
2022-12-13 09:44:34 +00:00
Benjamin Grandfond 81c885abcd
Add an architecture section
Co-authored-by: Guillaume Tardif <guillaume.tardif@gmail.com>
Co-authored-by: Usha Mandya <47779042+usha-mandya@users.noreply.github.com>
Co-authored-by: Felipe Cruz Martinez <15997951+felipecruz91@users.noreply.github.com>
2022-12-13 09:35:02 +01:00
Guillaume Tardif d869afd60d Fix format for code section that was badly rendering the entire page
Signed-off-by: Guillaume Tardif <guillaume.tardif@gmail.com>
2022-12-12 18:19:02 +01:00
Ivan Curkovic 1879c281fb
Update of debug section (#16312)
- npm script was changed, command is different as well as port
2022-12-10 10:08:51 +00:00
Usha Mandya 66e21d5205
Merge pull request #16306 from benja-M-1/extension/open-form-new-tab
[Extension] Link to ask for other techs in the doc should open in a new tab
2022-12-09 19:44:34 +00:00
Benjamin Grandfond c0f2de06f1
Make the form link open in new tab 2022-12-08 16:51:25 +01:00
Sebastiaan van Stijn 4ca3621f01
desktop/extensions-sdk: add syntax directives to dockerfile examples
Signed-off-by: Sebastiaan van Stijn <github@gone.nl>
2022-12-08 16:42:11 +01:00
Benjamin Grandfond 90ca64879c
Rework extension backend doc (#16236)
* Genericize frontend tutorial and make it clear other tech are usable and track it

* Rework backend tutorial to add tabs for other techs and incorporate the build and install commands.

* Guillaume's feedback
2022-12-06 16:11:54 +00:00
Guillaume Tardif 4c8c02fe4b
Reorganise extension part 2: publish section (#16268)
* Add doc about sharing extensions

Signed-off-by: Guillaume Tardif <guillaume.tardif@gmail.com>

* Re-organise extension publish section

Signed-off-by: Guillaume Tardif <guillaume.tardif@gmail.com>

Signed-off-by: Guillaume Tardif <guillaume.tardif@gmail.com>
2022-12-06 16:08:38 +00:00
Allie Sadler 87b5615982
DD 4.15: extensions content changes (#16187)
* DD 4.15: extensions content changes

* addition of share content
2022-12-01 15:26:23 +00:00
Benjamin Grandfond 9f48561e2d
Add guide about host binaries (#16198)
* Add host binary guide and move others to this section

* Fixes, improvements fronm review

* Update the example with a working version on windows

* More feedback from the team

* Fix tab id

* Fix broken links and images
2022-11-28 17:47:49 +00:00
Benjamin Grandfond 3e1e0335a6
Genericize frontend tutorial and make it clear other tech are usable and track it (#16195)
* Genericize frontend tutorial and make it clear other tech are usable and track it

* Fix linking

* Add some space before the callout

* Review feedback

* Fix link
2022-11-28 10:46:43 +00:00
Benjamin Grandfond c1f86e29c6
Add some mention to show extension containers from other places in the doc (#16175)
* Add some mention to show extension containers from other places in the doc

* Update desktop/extensions-sdk/quickstart.md

Co-authored-by: Allie Sadler <102604716+aevesdocker@users.noreply.github.com>
2022-11-17 17:18:39 +00:00
Allie Sadler 3f0cded22f
SDK landing page reorg (#16174)
* SDK landing page reorg

* fix link
2022-11-17 12:04:27 +00:00
Benjamin Grandfond be4d6cddc8
Add a more complete example on how to call the SDK and display the result in a React app (#16161)
* Add a more complete example on how to call the SDK and display the result in a React app

* Try to escape curly brackets to fix liquid error
2022-11-15 10:15:19 +00:00
Allie Sadler 2a1fd8eb23
style guide alignments (#16111)
* style guide alignments

* fix

* Update desktop/extensions-sdk/quickstart.md

Co-authored-by: David Karlsson <35727626+dvdksn@users.noreply.github.com>

* Update desktop/extensions-sdk/build/build-install.md

Co-authored-by: David Karlsson <35727626+dvdksn@users.noreply.github.com>

* Update desktop/extensions-sdk/build/test-debug.md

Co-authored-by: David Karlsson <35727626+dvdksn@users.noreply.github.com>

* Update desktop/extensions-sdk/build/test-debug.md

Co-authored-by: David Karlsson <35727626+dvdksn@users.noreply.github.com>

* Update desktop/extensions-sdk/build/test-debug.md

Co-authored-by: David Karlsson <35727626+dvdksn@users.noreply.github.com>

* Update desktop/extensions-sdk/quickstart.md

Co-authored-by: David Karlsson <35727626+dvdksn@users.noreply.github.com>

* Update desktop/extensions-sdk/quickstart.md

Co-authored-by: David Karlsson <35727626+dvdksn@users.noreply.github.com>

Co-authored-by: David Karlsson <35727626+dvdksn@users.noreply.github.com>
2022-11-07 15:56:38 +00:00
CrazyMax 61e3cb1ce1
remove absolute links
Signed-off-by: CrazyMax <crazy-max@users.noreply.github.com>
2022-11-05 11:10:32 +01:00
Allie Sadler 8125871469
Make how to publish extensions more clear (#16067)
* Make how to publish extensions more clear

* fixes

* fix

* toc fix

* Update desktop/extensions-sdk/extensions/index.md

Co-authored-by: David Karlsson <35727626+dvdksn@users.noreply.github.com>

* Update desktop/extensions-sdk/extensions/index.md

Co-authored-by: David Karlsson <35727626+dvdksn@users.noreply.github.com>

* Update desktop/extensions-sdk/extensions/index.md

Co-authored-by: David Karlsson <35727626+dvdksn@users.noreply.github.com>

* Update desktop/extensions-sdk/extensions/index.md

Co-authored-by: David Karlsson <35727626+dvdksn@users.noreply.github.com>

* Update desktop/extensions-sdk/extensions/index.md

Co-authored-by: David Karlsson <35727626+dvdksn@users.noreply.github.com>

* Update desktop/extensions-sdk/extensions/index.md

Co-authored-by: David Karlsson <35727626+dvdksn@users.noreply.github.com>

* Update desktop/extensions-sdk/build/test-debug.md

Co-authored-by: David Karlsson <35727626+dvdksn@users.noreply.github.com>

Co-authored-by: David Karlsson <35727626+dvdksn@users.noreply.github.com>
2022-11-04 12:47:34 +00:00
Felipe Cruz Martinez 75ea0f0bd4
Interacting with K8s from a Docker Extension (#15896)
* Interacting with K8s from a Docker Extension

* Apply suggestions from code review

Co-authored-by: Allie Sadler <102604716+aevesdocker@users.noreply.github.com>

* Add Kubernetes sample extension link

Co-authored-by: Allie Sadler <102604716+aevesdocker@users.noreply.github.com>
2022-10-19 13:03:50 +01:00
Felipe Cruz Martinez 5a29cf63bd
Add `cloud-development` as a new extension category (#15805) 2022-10-05 08:45:25 +01:00
Guillaume Tardif f8a609a768
Add license info for extension authors (#15726)
* Add license info for extension authors

Signed-off-by: Guillaume Tardif <guillaume.tardif@gmail.com>

* Update desktop/faqs/general.md

Signed-off-by: Guillaume Tardif <guillaume.tardif@gmail.com>
Co-authored-by: Allie Sadler <102604716+aevesdocker@users.noreply.github.com>
2022-09-23 10:22:30 +00:00
Felipe Cruz Martinez c13a9bc50b
Document how to add Marketplace categories to Docker Extensions (#15716) 2022-09-22 07:51:09 +00:00
Guillaume Tardif 6228d4e263
Direct extension authors to the quickstart guide rather than samples when they start creating a codebase for their new extensions (#15702)
* Direct extension authors to the quickstart guide rather than samples when they start creating a codebase for their new extensions

Signed-off-by: Guillaume Tardif <guillaume.tardif@gmail.com>

* Apply suggestions from code review

Co-authored-by: Allie Sadler <102604716+aevesdocker@users.noreply.github.com>

* Fix warning class not picked up properly in note

Signed-off-by: Guillaume Tardif <guillaume.tardif@gmail.com>

Signed-off-by: Guillaume Tardif <guillaume.tardif@gmail.com>
Co-authored-by: Allie Sadler <102604716+aevesdocker@users.noreply.github.com>
2022-09-22 08:50:25 +01:00
Guillaume Tardif efb9ca8caf
Extension sdk update (#15687)
* Update extension SDK with new APIs for exec with ENV vars and CWD

Signed-off-by: Guillaume Tardif <guillaume.tardif@gmail.com>

* Update extension SDK with new APIs for exec with ENV vars and CWD

Signed-off-by: Guillaume Tardif <guillaume.tardif@gmail.com>

Signed-off-by: Guillaume Tardif <guillaume.tardif@gmail.com>
2022-09-20 09:46:44 +01:00
CrazyMax 8349c857bf
extension(multi-arch): refactor and cross link to multi-platform page
Signed-off-by: CrazyMax <crazy-max@users.noreply.github.com>
2022-09-14 12:25:25 +02:00
Guillaume Tardif a0b7f4f8b2
extension SDK : cannot chain commands in exec() (#15627)
* extension SDK : cannot chain commands in exec()

Signed-off-by: Guillaume Tardif <guillaume.tardif@gmail.com>

* Apply suggestions from code review

Co-authored-by: Allie Sadler <102604716+aevesdocker@users.noreply.github.com>

Signed-off-by: Guillaume Tardif <guillaume.tardif@gmail.com>
Co-authored-by: Allie Sadler <102604716+aevesdocker@users.noreply.github.com>
2022-09-13 13:07:12 +01:00