Skip to content

Document the validation tools #241

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

Merged
merged 18 commits into from
Feb 19, 2021
Merged

Conversation

svdimitr
Copy link
Contributor

@svdimitr svdimitr commented Feb 19, 2021

General tasks for a new feature (delete if not applicable)

  • Check links to and from demos, demos descriptions and metadata
  • Update relevant KB articles or sample projects that may now be easier or cover the scenario that is not built-in

New Component Checklist (delete for other types of PRs)

  • - Overview article

    • General information on the purpose of the component.
    • Instruction on how to add the component to a razor component.
    • Basic configuration of the component - code snippet with a scenario that is both basic, and meaningful.
    • Provide information on the component's reference.
    • List the available features for the component and/or provide links (slugs) for the articles that explain them in details. For simpler components listing parameters might be enough, for more complex ones sections with a sentence or two that links corresponding articles might be more suitable.
    • Maybe some Example(s) - very common scenarios, notes, typical use case, etc. Not mandatory, depends on the component.
  • - Data binding article - applicable if data can be provided to the component. My be one article or a folder with several articles (examples - DropDownList and TreeView)

  • - Feature/component specific articles - those articles explain the component specific features, which do not suit in any of the before-mentioned articles. Examples of such articles are the Navigator for the Stock Chart, the Indeterminate state for the CheckBox and others.

  • - Selection article - applicable if the component exposes items selection. May be a folder.
    [ ] - Single item selection
    [ ] - Multiple item selection

  • - Templates - applicable if additional customization is allowed with Templates. Usually a folder, see the grid

  • - Events article - applicable if the component expose events.
    Examples of such events could be:

  • OnClick
  • OnChange
  • ValueChanged
  • SelectedItemsChanged
  • OnRead
  • etc.
  • Update Input Validation, Globalization, Keyboard Navigation, Accessibility Compliance articles as applicable.

  • Link from the Overview components list

@svdimitr svdimitr self-assigned this Feb 19, 2021
@marin-bratanov marin-bratanov force-pushed the docs-validation-components branch from cda2360 to c71054e Compare February 19, 2021 18:19
@marin-bratanov marin-bratanov merged commit 5a15f9e into master Feb 19, 2021
@marin-bratanov marin-bratanov deleted the docs-validation-components branch February 19, 2021 19:12
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