Skip to content

Conversation

@ptitzler
Copy link
Member

@ptitzler ptitzler commented Mar 1, 2023

[Updated PR]

  • Remove references to the binder service from the repository readme and documentation
  • Improve/simplify installation documentation

What changes were proposed in this pull request?

See above

How was this pull request tested?

Reviewed the updated readme.md and built documentation

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.

Signed-off-by: Patrick Titzler <[email protected]>
@ptitzler ptitzler added kind:bug Something isn't working area:documentation Improvements or additions to documentation component:build build and build related issues(dependencies and docker) labels Mar 1, 2023
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.

A couple comments (and an opinion 😄). I personally find the hell that is version-string management in documentation to not be worth the effort.

@ptitzler ptitzler marked this pull request as draft March 2, 2023 17:38
@ptitzler ptitzler changed the title Fix binder link in repository README and release script Hide binder links and references Mar 2, 2023
@ptitzler ptitzler marked this pull request as ready for review March 2, 2023 18:25
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.

If we're going to comment out lines of code, we should ensure the lines are working since that will be assumed when folks decide to uncomment those lines.

Personally, I view this as the role of source code control history and advocate their removal altogether.

Signed-off-by: Patrick Titzler <[email protected]>
@ptitzler
Copy link
Member Author

ptitzler commented Mar 2, 2023

If we're going to comment out lines of code, we should ensure the lines are working since that will be assumed when folks decide to uncomment those lines.

Personally, I view this as the role of source code control history and advocate their removal altogether.

Done!

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.

Thanks @ptitzler - these changes look good.

@ptitzler ptitzler merged commit faa65b8 into elyra-ai:main Mar 3, 2023
@ptitzler ptitzler deleted the fix-binder-pattern branch March 3, 2023 15:13
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 component:build build and build related issues(dependencies and docker) kind:bug Something isn't working

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants