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

Make small improvements to the documentation #1157

Merged
merged 5 commits into from
Jun 18, 2024

Conversation

james-garriss
Copy link
Collaborator

@james-garriss james-garriss commented Jun 10, 2024

🗣 Description

I made the following changes to improvement the documentation:

  • Fixed 404 on Execution
  • Converted results on Reports into a table for better readability
  • Removed extra space on Parameters
  • Replaced with johndoe on Dependencies (and others) for better render.
  • Clarified purpose of commented out product values in Typical Use section of Configuration.
  • Fixed hyperlink on Execution to jump directly to ProductNames

💭 Motivation and context

Closes #1154
Closes #1156

🧪 Testing

Previewed changes in VSCode.

✅ Pre-approval checklist

  • This PR has an informative and human-readable title.
  • PR targets the correct parent branch (e.g., main or release-name) for merge.
  • Changes are limited to a single goal - eschew scope creep!
  • Changes are sized such that they do not touch excessive number of files.
  • Related issues these changes resolve are linked preferably via closing keywords.
  • All relevant type-of-change labels added.
  • All relevant project fields are set.
  • All relevant repo and/or project documentation updated to reflect these changes.
  • All automated checks (e.g., linting, static analysis, unit/smoke tests) passed.

✅ Pre-merge checklist

  • PR passed smoke test check.
  • Feature branch has been rebased against changes from parent branch, as needed
  • Resolved all merge conflicts on branch
  • Notified merge coordinator that PR is ready for merge via comment mention

✅ Post-merge checklist

  • Feature branch deleted after merge to clean up repository.
  • Verified that all checks pass on parent branch (e.g., main or release-name) after merge.

@james-garriss james-garriss added documentation This issue or pull request improves or adds to documentation enhancement This issue or pull request will add new or improve existing functionality labels Jun 10, 2024
@james-garriss james-garriss self-assigned this Jun 10, 2024
@james-garriss james-garriss added this to the Iceberg milestone Jun 10, 2024
@james-garriss
Copy link
Collaborator Author

@nanda-katikaneni , this one is ready (again)

@nanda-katikaneni nanda-katikaneni merged commit b50a501 into main Jun 18, 2024
14 checks passed
@nanda-katikaneni nanda-katikaneni deleted the 1156-make-doc-improvements branch June 18, 2024 19:39
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation This issue or pull request improves or adds to documentation enhancement This issue or pull request will add new or improve existing functionality
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Make small improvements to the documentation Minor inaccuracy in the MergeJson documentation
4 participants