Reformatted ReadMe File #104
Open
Conversation
This file contains hidden or 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
Update README.md with sample datasets
Adding the Architectural design of DOT to the images collection, so it can be added to the readme file
adding the modifications according to the first video. everything got removed after I did some upload via web
adding the landing page of the readme, though it is still a work in progress.
Adding documentation folder getting started page
adding link to the getting started page
adding setting up docker page
modified setup file documentation
adding link to the readme file on the second section of the configuration documentation
removed extra spacing
adding airflow deployment instructions
correcting format and adding hyperlink in the readme.
added docker management steps while using Airflow
fixing spacing in the airflow setup file
fixing heading in the airflow file
fixing main readme
adding the demo to the airflow deployment
fixing heading in the airflow deployment document
adding the configuration of the DOT database steps
adding the link to the db configuration steps to the main readme file
adding CLI instructions to see DB data into the db configuration file
adding format to the setup and getting started files
Adding two more sections of the documentation, and fixing the readme file.
aadding link of appsmith documentation to the readme.
addng a new page
fix format
fixing format
remove comment on the list of the pages that was in the readme. added links to the pages on ConfiguringDOT, and DBTforDOT
Author
|
@dividor and @jacobrharris, I'm assuming I don't have to open another pull request for the readme documentation. I went ahead and also added the synthetic dataset I generated and created a folder for it within the repo. it is not linked to the read me yet, but that folder can hold the other datasets that have been generated, and everybody can have access from there or it can be added to the google drive of the sample datasets in the original readme. let me know if you have any questions as you review it.- Wendy |
Adding synthetic dataset in json file added images to be added in the connection to db on airflow for clarity
removing images from the DOT_doc folder as they were already in the images folder added the images to the documentation
added extra aid in the db connection setup and how to
corrected image link
fixed image link
added imaes that will help on clarification as to where the information needs to be enter at time of configuration.
added visual aids for the DAG on airflow interface
linking the images to the documentation
- adding visual aids on parts of the documentations where it was a bt confusing to where it was the database being setup
…neral configuration requirements added a note regarding spacing in the general configuration requirements of the application.
Added the note at the beginning of the general configurration requirements the space allocated for the application
adding diagrams for documentation comprehension of DOT
Author
|
@dividor and @jacobrharris, I added Diagrams (road maps, and DOT structure for clarity. Though it is not incorporated in the documentation because that will depend on where you want to place it. it could actually replace the architectural diagram as it gives the big picture of the set up) but I will leave that for you decide. |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
4 participants
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.
Fixes # Fusing readMe
Proposed Changes