Skip to content

Add config JSON tutorial and improve README documentation#50

Merged
khanahmedm merged 6 commits into
developfrom
feature/docs
Mar 10, 2026
Merged

Add config JSON tutorial and improve README documentation#50
khanahmedm merged 6 commits into
developfrom
feature/docs

Conversation

@khanahmedm

Copy link
Copy Markdown
Collaborator

This PR adds a new tutorial explaining how to create JSON configuration files for the data lakehouse ingest library and includes documentation improvements in the README.

Comment thread tutorial-config-json.md Outdated
Comment on lines +58 to +61
```
"tenant": "globalusers",
"dataset": "ontology_test1"
```

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

you can enable syntax highlighting like so:

    ```json
      "tag": "value",
    ```

Copy link
Copy Markdown
Collaborator Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I've enabled syntax highlighting here and other places in the markdown.

Comment thread tutorial-config-json.md
Comment on lines +74 to +78

```
dataset = ontology_test1
username = akhan
```

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

make sure the format here is consistent with the example above

Copy link
Copy Markdown
Collaborator Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I've updated it.

@codecov

codecov Bot commented Mar 9, 2026

Copy link
Copy Markdown

Codecov Report

✅ All modified and coverable lines are covered by tests.
✅ Project coverage is 94.46%. Comparing base (34e5431) to head (e1e3e67).
⚠️ Report is 7 commits behind head on develop.

Additional details and impacted files
@@           Coverage Diff            @@
##           develop      #50   +/-   ##
========================================
  Coverage    94.46%   94.46%           
========================================
  Files           17       17           
  Lines          813      813           
========================================
  Hits           768      768           
  Misses          45       45           

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

🚀 New features to boost your workflow:
  • ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.

@khanahmedm

Copy link
Copy Markdown
Collaborator Author

I've removed LLM generated irrelevant content from the tutorial.

Comment thread tutorial-config-json.md Outdated
u_<username>__<dataset>
```

This personal namespace allows users to run ingestion jobs and experiment with datasets without modifying shared tenant namespaces.

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

...without modifying shared tenant resources? datasets? "namespaces" is a bit vague.

Copy link
Copy Markdown
Collaborator Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I updated the wording to clarify this.

@khanahmedm
khanahmedm merged commit 821bb29 into develop Mar 10, 2026
11 checks passed
@khanahmedm
khanahmedm deleted the feature/docs branch March 10, 2026 20:40
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.

2 participants