You are viewing a plain text version of this content. The canonical link for it is here.
Posted to issues@openwhisk.apache.org by GitBox <gi...@apache.org> on 2020/04/06 17:24:02 UTC
[GitHub] [openwhisk] modlanglais opened a new pull request #4873: Updates
repo diagram to reflect current components
modlanglais opened a new pull request #4873: Updates repo diagram to reflect current components
URL: https://github.com/apache/openwhisk/pull/4873
## Description
Fixes issue #3553: This change converts the repo diagram to two tables instead of a static image. It updates the components to reflect components that are active today. After discussion with @mrutkows, we decided to use a markdown table instead of an image to promote maintainability.
## Related issue and scope
- [ ] I opened an issue to propose and discuss this change (#???)
## My changes affect the following components
- [ ] API
- [ ] Controller
- [ ] Message Bus (e.g., Kafka)
- [ ] Loadbalancer
- [ ] Invoker
- [ ] Intrinsic actions (e.g., sequences, conductors)
- [ ] Data stores (e.g., CouchDB)
- [ ] Tests
- [ ] Deployment
- [ ] CLI
- [ ] General tooling
- [x] Documentation
## Types of changes
- [x] Bug fix (generally a non-breaking change which closes an issue).
- [ ] Enhancement or new feature (adds new functionality).
- [ ] Breaking change (a bug fix or enhancement which changes existing behavior).
## Checklist:
- [x] I signed an [Apache CLA](https://github.com/apache/openwhisk/blob/master/CONTRIBUTING.md).
- [x] I reviewed the [style guides](https://github.com/apache/openwhisk/wiki/Contributing:-Git-guidelines#code-readiness) and followed the recommendations (Travis CI will check :).
- [ ] I added tests to cover my changes.
- [ ] My changes require further changes to the documentation.
- [x] I updated the documentation where necessary.
----------------------------------------------------------------
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
With regards,
Apache Git Services
[GitHub] [openwhisk] mrutkows commented on issue #4873: Updates repo diagram
to reflect current components
Posted by GitBox <gi...@apache.org>.
mrutkows commented on issue #4873: Updates repo diagram to reflect current components
URL: https://github.com/apache/openwhisk/pull/4873#issuecomment-610404486
@dgrove-oss so what do want done with the green diagram which is incorrect?
----------------------------------------------------------------
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
With regards,
Apache Git Services
[GitHub] [openwhisk] modlanglais edited a comment on issue #4873: Updates
repo diagram to reflect current components
Posted by GitBox <gi...@apache.org>.
modlanglais edited a comment on issue #4873: Updates repo diagram to reflect current components
URL: https://github.com/apache/openwhisk/pull/4873#issuecomment-610481637
@dgrove-oss if you think the best solution is a static image, I can just create a new image with the correct components listed. Further, I could do some image mapping using HTML to create a link to each component from within the image. Just let me know what option you would prefer.
----------------------------------------------------------------
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
With regards,
Apache Git Services
[GitHub] [openwhisk] mrutkows edited a comment on issue #4873: Updates repo
diagram to reflect current components
Posted by GitBox <gi...@apache.org>.
mrutkows edited a comment on issue #4873: Updates repo diagram to reflect current components
URL: https://github.com/apache/openwhisk/pull/4873#issuecomment-610003591
@dgrove-oss mostly for 2 reasons
1) had a vague recollection (only after your linking) that this existed.
2) was strictly trying to address the old diagram on the README and provide a current substitute to a person seeing the README first coming to the project (and an issue that likely predates that automation). Believe a graphical depiction is more powerful (would hate to delete and provide a link that may never be followed).
Perhaps automation (despite markdown not supporting imports) would be possible, but a short term correction may be in order. we can link to that document, but perhaps seek to avoid duplication.
----------------------------------------------------------------
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
With regards,
Apache Git Services
[GitHub] [openwhisk] mrutkows commented on issue #4873: Updates repo diagram
to reflect current components
Posted by GitBox <gi...@apache.org>.
mrutkows commented on issue #4873: Updates repo diagram to reflect current components
URL: https://github.com/apache/openwhisk/pull/4873#issuecomment-610003591
@dgrove-oss mostly for 2 reasons
1) had a vague recollection (only after your linking) that this existed.
2) was strictly trying to address the old diagram on the README and provide a current substitute to a person seeing the README first coming to the project.
Perhaps automation (despite markdown not supporting imports) would be possible, but a short term correction may be in order. we can link to that document, but perhaps seek to avoid duplication.
----------------------------------------------------------------
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
With regards,
Apache Git Services
[GitHub] [openwhisk] dgrove-oss commented on issue #4873: Updates repo
diagram to reflect current components
Posted by GitBox <gi...@apache.org>.
dgrove-oss commented on issue #4873: Updates repo diagram to reflect current components
URL: https://github.com/apache/openwhisk/pull/4873#issuecomment-609936737
We have tooling that generates https://github.com/apache/openwhisk/blob/master/docs/dev/modules.md
Should we be leveraging that here instead of having a manual list?
----------------------------------------------------------------
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
With regards,
Apache Git Services
[GitHub] [openwhisk] dgrove-oss commented on issue #4873: Updates repo
diagram to reflect current components
Posted by GitBox <gi...@apache.org>.
dgrove-oss commented on issue #4873: Updates repo diagram to reflect current components
URL: https://github.com/apache/openwhisk/pull/4873#issuecomment-609981999
@mrutkows -- The first line of this paragraph is a link to the generated dev/modules.md file. The module list is fairly well organized, has the hyperlinks. Why duplicate?
----------------------------------------------------------------
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
With regards,
Apache Git Services
[GitHub] [openwhisk] mrutkows edited a comment on issue #4873: Updates repo
diagram to reflect current components
Posted by GitBox <gi...@apache.org>.
mrutkows edited a comment on issue #4873: Updates repo diagram to reflect current components
URL: https://github.com/apache/openwhisk/pull/4873#issuecomment-610003591
@dgrove-oss mostly for 2 reasons
1) had a vague recollection (only after your linking) that this existed.
2) was strictly trying to address the old diagram on the README and provide a current substitute to a person seeing the README first coming to the project (and an issue that likely predates that automation).
Perhaps automation (despite markdown not supporting imports) would be possible, but a short term correction may be in order. we can link to that document, but perhaps seek to avoid duplication.
----------------------------------------------------------------
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
With regards,
Apache Git Services
[GitHub] [openwhisk] dgrove-oss commented on issue #4873: Updates repo
diagram to reflect current components
Posted by GitBox <gi...@apache.org>.
dgrove-oss commented on issue #4873: Updates repo diagram to reflect current components
URL: https://github.com/apache/openwhisk/pull/4873#issuecomment-611265529
Hi Morgan, its great you are putting the time into updating this. I'm fine with either a markdown table or an image.
I agree with you that a markdown table will probably be easier to maintain. You might be able to seed that markdown table by grabbing the rows for the "active" projects from the modules.md file, copying them into the main readme, and adjusting. I was initially hoping to be able to generate this new table using the same machinery we are using to generate modules.md, but since markdown doesn't support including files its probably not worth the effort. Module structure doesn't change that rapidly.
----------------------------------------------------------------
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
With regards,
Apache Git Services
[GitHub] [openwhisk] modlanglais commented on issue #4873: Updates repo
diagram to reflect current components
Posted by GitBox <gi...@apache.org>.
modlanglais commented on issue #4873: Updates repo diagram to reflect current components
URL: https://github.com/apache/openwhisk/pull/4873#issuecomment-610481637
@dgrove-oss if you think the best solution is a static image, I can just create a new image with the correct components listed. Further, I could image mapping using HTML to create a link to each component from within the image. Just let me know what option you would prefer.
----------------------------------------------------------------
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
With regards,
Apache Git Services