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

add "getting help" doc topic #1100

Merged
merged 2 commits into from
Nov 30, 2020
Merged

add "getting help" doc topic #1100

merged 2 commits into from
Nov 30, 2020

Conversation

ptitzler
Copy link
Member

@ptitzler ptitzler commented Nov 23, 2020

In part prompted by some of the concerns raised in https://discourse.jupyter.org/t/benefits-of-the-classic-ui-and-use-cases-for-classic-over-jupyterlab-was-why-is-tim-not-moving-to-lab/2419, this PR is a first attempt to further improve the native getting started experience for new users.

Generally speaking there are three common Elyra entry points that users are likely to access:

New users are likely going to have questions, feedback, or run into issues. This PR adds a new sub-section to the "getting started" section, which should enable the reader to do that.

image

The proposed section title is just a proposal. Ideally the name conveys to the user that this is the community entry point, which links to all appropriate resources, including github, gitter, stack overflow etc.

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 Nov 23, 2020

Thanks for making a pull request to Elyra!

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

@ptitzler ptitzler added the area:documentation Improvements or additions to documentation label Nov 23, 2020
@lresende
Copy link
Member

How about we change the developer guide to contributor guide and make this section part of that?

@ptitzler
Copy link
Member Author

I like the idea of renaming "developer guide" to "contributor guide". It feels more inclusive. I am a bit reserved though about putting help information in that section. I know we like to frame github issues as contributions in meetups but I don't think the majority of users would look in that location for help. Perhaps we could change the scope of this sub-section to be just "Getting help" and linking to the contributor guide from there?

@ptitzler ptitzler changed the title add improving-elyra doc topic add "getting help" doc topic Nov 23, 2020
@ptitzler
Copy link
Member Author

Updated the topic to be about "getting help" instead of helping improve Elyra.

@lresende lresende merged commit 7d9c376 into elyra-ai:master Nov 30, 2020
@lresende lresende added this to the 2.0.0 milestone Nov 30, 2020
@ptitzler ptitzler deleted the improving_elyra branch December 14, 2020 20:10
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.

None yet

2 participants