Update ARCHITECTURE.md #393
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
stichbury
requested review from
studioswong
and removed request for
richardwestenra
studioswong
reviewed
Mar 12, 2021
studioswong
reviewed
Mar 12, 2021
There was a problem hiding this comment.
LGTM - Thanks for the review and suggestions Jo! @stichbury
Just one comment as above - otherwise happy to approve!
richardwestenra
approved these changes
Mar 12, 2021
stichbury
commented
Mar 17, 2021
Co-authored-by: Richard Westenra <[email protected]>
stichbury
commented
Mar 17, 2021
stichbury
commented
Mar 17, 2021
studioswong
added a commit
that referenced
this pull request
Mar 18, 2021
* add architecture doc * initial setup of Architecture docs structure * more draft * further setup of codemap * further updates on codemap * further formatting * added new data flow section and updated text as per comments * added diagrams to architecture docs * added further elaboration on react component import * update formatting * correct format * update app architecture entry point diagram * updated image reference * update data flow section * update image link * update links * update image * Use consistent capitalization on 'Kedro-Viz' It's Kedro-Viz, not kedro-viz or Kedro-viz. * Consistently add newlines after headings * add in new app structure section with app-architecture diagram * Edit/rewrite architecture doc - I've removed/rewritten some paragraphs that aren't particularly useful, or which are factually incorrect. - In external-facing documentation, we should try to ensure consistent capitalisation, e.g. Kedro-Viz (not kedro-viz or Kedro-viz), and React (not react). I've updated these. - Avoid trailing whitespace. - Reduce verbocity. There were a few paragraphs that read like filler, and do not contribute to understanding. I've simplified or excised where prudent. - I've moved a lot of content around into new sections. Much of the content was useful but would be better understood if grouped differently, e.g. by topic instead of by file name or directory. We don't need a summary of what each file does, we need a summary of what the entire app does. * Minor wording changes * Update ARCHITECTURE.md (#393) Some updates plus resolved changes following feedback * Revert 'npmjs.com' to 'npm' In this case we're referring to the registry/CLI, not the website. * Update ARCHITECTURE.md Co-authored-by: Yetunde Dada <[email protected]> * Update ARCHITECTURE.md Co-authored-by: Yetunde Dada <[email protected]> * Update ARCHITECTURE.md Co-authored-by: Yetunde Dada <[email protected]> * Improve wording based on Liam's suggestions Co-authored-by: Richard Westenra <[email protected]> Co-authored-by: Jo Stichbury <[email protected]> Co-authored-by: Yetunde Dada <[email protected]>
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Description
Minor tweaks to architecture documentation as part of PR review
Development notes
QA notes
Checklist
RELEASE.mdfileLegal notice
I acknowledge and agree that, by checking this box and clicking "Submit Pull Request":
I submit this contribution under the Apache 2.0 license and represent that I am entitled to do so on behalf of myself, my employer, or relevant third parties, as applicable.
I certify that (a) this contribution is my original creation and / or (b) to the extent it is not my original creation, I am authorised to submit this contribution on behalf of the original creator(s) or their licensees.
I certify that the use of this contribution as authorised by the Apache 2.0 license does not violate the intellectual property rights of anyone else.