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.

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

Replace outdated factories info with sharing workspace with devfile URL #1745

Merged
merged 9 commits into from
Dec 17, 2020

Conversation

sleshchenko
Copy link
Member

@sleshchenko sleshchenko commented Dec 16, 2020

Read our Contribution guide before submitting a PR.

What does this PR do?

This PR replaces outdated factories info with sharing workspace with devfile URL in the publishing plugin article.
Modified article https://5fda36a78a76bb0fd46c4038--eclipse-che-docs-pr.netlify.app/che-7/contributor-guide/publishing-che-theia-plug-ins/

What issues does this PR fix or reference?

It's done in the scope of eclipse-che/che#18518

Specify the version of the product this PR applies to.

7.23 and even earlier

PR Checklist

As the author of this Pull Request I made sure that:

  • vale has been run successfully against the PR branch
  • Link checker has been run successfully against the PR branch
  • Documentation describes a scenario that is already covered by QE tests, otherwise an issue has been created and acknowledged by Che QE team
  • Changed article references are updated where they are used (or a redirect has been set up on the docs side):

----
+
Reference URL examples:
+
* pass:[https://custom-registry/v3/plugins/custom-plugin-name/0.0.1/]
* pass:[https://raw.githubusercontent.com/username/che-custom-plugins/master/v3/plugins/custom-plugin-name/0.0.1/meta.yaml]

[id="sharing-a-plug-in-with-factory-url_{context}"]
== By preparing shareable Devfile
Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This section is mostly copy/paste from removed factory section where I replaces removed persisted factories with che-host/f?url=... link.
For me, it does not seem detailed and clear enough but I don't have any experience with writing plugins and not sure how it can be made better.

Comment on lines 48 to 51
Reference URL examples:
+
* pass:[https://custom-registry/v3/plugins/custom-plugin-name/0.0.1/]
* pass:[https://raw.githubusercontent.com/username/che-custom-plugins/master/v3/plugins/custom-plugin-name/0.0.1/meta.yaml]
Copy link
Contributor

@themr0c themr0c Dec 16, 2020

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
Reference URL examples:
+
* pass:[https://custom-registry/v3/plugins/custom-plugin-name/0.0.1/]
* pass:[https://raw.githubusercontent.com/username/che-custom-plugins/master/v3/plugins/custom-plugin-name/0.0.1/meta.yaml]
.`chePlugin` reference URL pointing to a plug-in `meta.yaml`
====
----
https://custom-registry/v3/plugins/custom-plugin-name/0.0.1/
https://raw.githubusercontent.com/username/che-custom-plugins/master/v3/plugins/custom-plugin-name/0.0.1/meta.yaml
----
====

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

It seems to be not URL but URLs, I'm not sure if we need provide them as separate examples or one with URLs in title

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I've applied:

.`chePlugin` reference URLs pointing to a plug-in `meta.yaml`
====
----
https://custom-registry/v3/plugins/custom-plugin-name/0.0.1/
https://raw.githubusercontent.com/username/che-custom-plugins/master/v3/plugins/custom-plugin-name/0.0.1/meta.yaml
----
====

But can split them to separate example, or just replace URLs -> URL if needed.

Comment on lines 64 to 65
* {prod-url-secure}/f?url=https://github.com/eclipse/che
* {prod-url-secure}/f?url=https://raw.githubusercontent.com/eclipse/che/master/devfile.yaml
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
* {prod-url-secure}/f?url=https://github.com/eclipse/che
* {prod-url-secure}/f?url=https://raw.githubusercontent.com/eclipse/che/master/devfile.yaml
.`chePlugin` reference URL pointing to a repository containing a devfile
====
{prod-url}/f?url=https://github.com/eclipse/che
====
+
.`chePlugin` reference URL pointing to a devfile
====
{prod-url}/f?url=https://raw.githubusercontent.com/eclipse/che/master/devfile.yaml
====

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

That's not chePlugin reference but a link to Che that will create a workspace via Factory flow with cheplugin inside after plugin author added it into devfile 💥

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I've applied

.Factory URL pointing to a repository containing a devfile
====
{prod-url}/f?url=https://github.com/eclipse/che
====
+
.Factory URL pointing to a devfile
====
{prod-url}/f?url=https://raw.githubusercontent.com/eclipse/che/master/devfile.yaml
====

sleshchenko and others added 7 commits December 16, 2020 17:47
…vfile URL

Co-authored-by: Fabrice Flore-Thébault <ffloreth@redhat.com>
…vfile URL

Co-authored-by: Fabrice Flore-Thébault <ffloreth@redhat.com>
…vfile URL

Co-authored-by: Fabrice Flore-Thébault <ffloreth@redhat.com>
…vfile URL

Co-authored-by: Fabrice Flore-Thébault <ffloreth@redhat.com>
…vfile URL

Co-authored-by: Fabrice Flore-Thébault <ffloreth@redhat.com>
@sleshchenko sleshchenko merged commit 262537f into master Dec 17, 2020
@sleshchenko sleshchenko deleted the publishingCheTheiaPlugins branch December 17, 2020 08:00
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants