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

Entries schema docs #4257

Merged
merged 5 commits into from
Dec 13, 2024
Merged

Entries schema docs #4257

merged 5 commits into from
Dec 13, 2024

Conversation

drernie
Copy link
Member

@drernie drernie commented Dec 11, 2024

Documentation updates, to increase clarity.

Update example to point to an actual entries schema
@drernie drernie requested a review from Copilot December 11, 2024 03:55

Choose a reason for hiding this comment

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

Copilot reviewed 1 out of 1 changed files in this pull request and generated no suggestions.

Copy link

codecov bot commented Dec 11, 2024

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 37.59%. Comparing base (6bb4291) to head (17792b0).
Report is 1 commits behind head on master.

Additional details and impacted files
@@           Coverage Diff            @@
##           master    #4257    +/-   ##
========================================
  Coverage   37.59%   37.59%            
========================================
  Files         769      769            
  Lines       33984    33984            
  Branches     5156     5361   +205     
========================================
  Hits        12775    12775            
  Misses      20665    20665            
  Partials      544      544            
Flag Coverage Δ
api-python 91.29% <ø> (ø)
catalog 15.61% <ø> (ø)
lambda 91.48% <ø> (ø)

Flags with carried forward coverage won't be shown. Click here to find out more.

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

@drernie drernie self-assigned this Dec 11, 2024
@drernie drernie requested a review from fiskus December 11, 2024 03:57
@drernie
Copy link
Member Author

drernie commented Dec 11, 2024

@fiskus Would you want to add your documentation about "auto-config" to this PR?

@drernie drernie requested a review from QuiltSimon December 11, 2024 04:01
@drernie drernie enabled auto-merge December 11, 2024 04:01
@fiskus
Copy link
Member

fiskus commented Dec 11, 2024

Thank you for reminding. Let's add "auto-config" docs in a separate PR: #4258

@drernie
Copy link
Member Author

drernie commented Dec 12, 2024

@QuiltSimon @fiskus Any other comments? Okay to merge?

@drernie drernie disabled auto-merge December 12, 2024 00:14
fiskus
fiskus previously approved these changes Dec 12, 2024
Copy link
Member

@fiskus fiskus left a comment

Choose a reason for hiding this comment

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

Changes look good! However, I think the underlying issue remains: the page is still too large and mixes tutorial content with documentation, as well as common use cases with rare cases. Perhaps we could consider splitting these into separate sections/pages in the future?

docs/advanced-features/workflows.md Outdated Show resolved Hide resolved
docs/advanced-features/workflows.md Outdated Show resolved Hide resolved
docs/advanced-features/workflows.md Show resolved Hide resolved
Co-authored-by: Maksim Chervonnyi <[email protected]>
@drernie drernie requested review from fiskus and Copilot December 12, 2024 23:16

Choose a reason for hiding this comment

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

Copilot reviewed 1 out of 1 changed files in this pull request and generated no suggestions.

@drernie drernie enabled auto-merge December 12, 2024 23:18
@drernie drernie added this pull request to the merge queue Dec 13, 2024
Merged via the queue into master with commit 35b954b Dec 13, 2024
37 checks passed
@drernie drernie deleted the entries-schema-docs branch December 13, 2024 09:23
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