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

Doc validation framework #1167

Open
wants to merge 10 commits into
base: 0820_public_docs
Choose a base branch
from

Conversation

souravbaner-da
Copy link
Contributor

Documentation added for Validation Framework.
Close #1111

@souravbaner-da souravbaner-da added the documentation Improvements or additions to documentation label Mar 16, 2024
@souravbaner-da souravbaner-da added this to the 0.8.1.0 milestone Mar 16, 2024
@souravbaner-da souravbaner-da self-assigned this Mar 16, 2024
@souravbaner-da souravbaner-da linked an issue Mar 16, 2024 that may be closed by this pull request
Copy link

sonarcloud bot commented Mar 18, 2024

Quality Gate Passed Quality Gate passed

Issues
0 New issues
0 Accepted issues

Measures
0 Security Hotspots
No data about Coverage
No data about Duplication

See analysis details on SonarCloud

@gueniai gueniai modified the milestones: 0.8.1.0, 0.8.2.0 May 8, 2024
@gueniai
Copy link
Contributor

gueniai commented Jun 17, 2024

@souravbaner-da Add info to the docs on how to schedule the last task to do Validation

@neilbest-db neilbest-db self-requested a review July 29, 2024 13:20
Copy link
Contributor

Choose a reason for hiding this comment

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

@souravbaner-da, please use code markdown for table_names, Validation_Identifiers, and 'literal values'.

Copy link
Contributor

@neilbest-db neilbest-db left a comment

Choose a reason for hiding this comment

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

See conversation I added today.

@gueniai gueniai changed the base branch from public_docs to 0820_public_docs July 30, 2024 20:09
neilbest-db and others added 2 commits August 7, 2024 11:54
- Use markdown for Spark `table_name`s, Scala `identifier`s, and
  `'literal values'` more consistently

- Simplify and reuse column descriptions in tables

- Simplify the text by replacing passive ("is done"),
  conditional ("would be done"), and second-person ("we do") verbs
  with imperatives or nouns.

- Simplify the text by removing unnecessary adverbs ("basically",
@souravbaner-da
Copy link
Contributor Author

@neilbest-db I have reformated the DeepDiveValidationFramework.md to make it more generalized

Copy link

sonarcloud bot commented Aug 12, 2024

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation
Projects
None yet
Development

Successfully merging this pull request may close these issues.

[Doc] - Documentation for Validation Framework
5 participants