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

Reformatted ReadMe File #104

Open
wants to merge 86 commits into
base: main
Choose a base branch
from
Open

Reformatted ReadMe File #104

wants to merge 86 commits into from

Conversation

wvelebanks
Copy link

@wvelebanks wvelebanks commented Dec 24, 2024

Fixes # Fusing readMe
Proposed Changes

  • Segmented and correctly formatted each section of the ReadMe file
  • Expanded on explanation where it was shorter and hard to understand
  • (Pending) will only need to connect each segment in a way that the user can go back and forth within each section after clicking one of the segments from the links in the readme file.
  • please ignore my PR from test_wcve branch I did the mistake while merging my own repository, sorry @jacobrharris

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.
adding links between configDOTdb and BDTforDOT,
adding link on DBT for DOT page to the advance topics page
remove comment on the list of the pages that was in the readme.
added links to the pages on ConfiguringDOT, and DBTforDOT
@wvelebanks
Copy link
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
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants