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

Update 'pipeline components' topic in the 'user guide' #2260

Closed
wants to merge 5 commits into from
Closed

Update 'pipeline components' topic in the 'user guide' #2260

wants to merge 5 commits into from

Conversation

ptitzler
Copy link
Member

@ptitzler ptitzler commented Oct 28, 2021

This PR updates the https://elyra.readthedocs.io/en/latest/user_guide/pipeline-components.html topic based on the changes delivered by #2241

  • introduce component catalogs and component catalog connectors
  • link to the component catalog marketplace
  • link to the BYO component catalog tutorial in the examples repository
  • update the custom component management reference
  • add reference for built-in component connectors

What changes were proposed in this pull request?

See above.

Some of the HREFs to the examples repository will be broken until elyra-ai/examples#78 was merged.

How was this pull request tested?

Reviewed the output of make docs

Developer's Certificate of Origin 1.1

   By making a contribution to this project, I certify that:

   (a) The contribution was created in whole or in part by me and I
       have the right to submit it under the Apache License 2.0; or

   (b) The contribution is based upon previous work that, to the best
       of my knowledge, is covered under an appropriate open source
       license and I have the right under that license to submit that
       work with modifications, whether created in whole or in part
       by me, under the same open source license (unless I am
       permitted to submit under a different license), as indicated
       in the file; or

   (c) The contribution was provided directly to me by some other
       person who certified (a), (b) or (c) and I have not modified
       it.

   (d) I understand and agree that this project and the contribution
       are public and that a record of the contribution (including all
       personal information I submit with it, including my sign-off) is
       maintained indefinitely and may be redistributed consistent with
       this project or the open source license(s) involved.

@elyra-bot
Copy link

elyra-bot bot commented Oct 28, 2021

Thanks for making a pull request to Elyra!

To try out this branch on binder, follow this link: Binder

@ptitzler ptitzler added area:documentation Improvements or additions to documentation status:Work in Progress Development in progress. A PR tagged with this label is not review ready unless stated otherwise. labels Oct 28, 2021
@ptitzler ptitzler added this to the 3.3.0 milestone Oct 28, 2021
@ptitzler ptitzler removed the status:Work in Progress Development in progress. A PR tagged with this label is not review ready unless stated otherwise. label Oct 28, 2021
@ptitzler
Copy link
Member Author

TODO: we need to update the CLI examples in section 'Managing custom components using the Elyra CLI' to reflect the latest changes

@ptitzler ptitzler changed the title Update pipeline component documentation topic Update 'pipeline components' topic in the 'user guide' Nov 5, 2021
#### Example custom components

For illustrative purposes the Elyra component registry includes a few custom components that you can use to get started. These example components and the generic components are pre-loaded into the pipeline editor palette by default.
For illustrative purposes the Elyra includes a few custom components that you can use to get started. These example components and the generic components are pre-loaded into the pipeline editor palette by default.
Copy link
Member

Choose a reason for hiding this comment

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

reminder: this will need to be updated once the examples are moved out of the repo.

Copy link
Member

@kevin-bates kevin-bates left a comment

Choose a reason for hiding this comment

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

We might as well circle back on this once the dust has settled on the various PRs.

@ptitzler
Copy link
Member Author

The documentation updates will be delivered in #2286

@ptitzler ptitzler marked this pull request as draft November 12, 2021 22:55
@ptitzler ptitzler closed this Nov 18, 2021
@ptitzler ptitzler deleted the byo-doc-updates branch November 18, 2021 16:14
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
area:documentation Improvements or additions to documentation
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants