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

Dev workflow documentation updates #2832

Merged
merged 7 commits into from
Aug 10, 2022

Conversation

salonee13
Copy link
Contributor

@salonee13 salonee13 commented Jul 12, 2022

What changes were proposed in this pull request?

Added lines to documentation to have the contributor check to see if they have yarn and node installed correctly.

How was this pull request tested?

Reviewed the page after 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 Jul 12, 2022

Thanks for making a pull request to Elyra!

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

@akchinSTC akchinSTC self-requested a review July 13, 2022 14:00
@kiersten-stokes kiersten-stokes added this to the 3.11.0 milestone Jul 13, 2022
@kiersten-stokes kiersten-stokes added the area:documentation Improvements or additions to documentation label Jul 13, 2022
@ptitzler ptitzler requested a review from kiersten-stokes July 18, 2022 15:45
Copy link
Member

@kiersten-stokes kiersten-stokes left a comment

Choose a reason for hiding this comment

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

LGTM! This will be good to have back in the docs to streamline future installations. Thanks!

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.

This PR looks great. I'm wondering, though, if we could add one more thing that just came up in this discussion? If not, no big deal - it could be tackled another time.

I think this would amount to:

  • adding a link to GNU Make to the Requirements section.
  • adding installation instructions - which would probably be best to just defer to the previously linked web page for their platform.
  • adding a verification step to run make from the github directory (and reference the output that is a couple sections below in Build & Installation

@akchinSTC
Copy link
Member

Sounds fair, Make should be included as a required utility, maybe include a small non-support disclaimer for windows and only include link for installation in *nix environments

@akchinSTC
Copy link
Member

@salonee13 - you're probably busy making changes to the community repository. Let us know if you are unable to get to this before semester end and we can merge as is.

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.

This looks good. Thank you for adding the information regarding make. I had a small comment regarding the time and location in which the make installation is verified.

docs/source/developer_guide/development-workflow.md Outdated Show resolved Hide resolved
Co-authored-by: Kevin Bates <kbates4@gmail.com>
@akchinSTC akchinSTC changed the title Dev workflow changes Dev workflow documentation updates Aug 10, 2022
@akchinSTC akchinSTC merged commit 6ee5aea into elyra-ai:main Aug 10, 2022
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.

4 participants