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

[FeatureRequest] Improve JSON Verification #97

Open
14 tasks
PsychoData opened this issue Feb 4, 2021 · 3 comments
Open
14 tasks

[FeatureRequest] Improve JSON Verification #97

PsychoData opened this issue Feb 4, 2021 · 3 comments
Assignees
Labels
enhancement New feature or request

Comments

@PsychoData
Copy link
Collaborator

PsychoData commented Feb 4, 2021

Improve JSON verification so that you will not have duplicate entries, or separate entries across pages that are duplicates

We shouldn't have separate entries on the Admin page and the End-User page that both link to portal.office.com or similar, because this might make them collide later or show duplicate entries

As we work on #91 I think this will become a more apparently issue.

Checks I can think of

  • No Duplicate entries between pages
  • Portal syntax validation
    • Each file in /_data/Portals/*.json should be able to convert as JSON
    • Each file Should be at least 1 Portal Group in each file
      • Each Portal Group should have at least 1 Portal in it
        • Each Portal must have a PrimaryURL Field
          • Each PrimaryURL must resolve as an https:// url (possibly http ok?)
        • Each Portal Must have a Portal Name
        • Each Portal can have up to two SecondaryURL's to show, none is also fine.
          • Each SecondaryURL text is no longer than 8 characters long
          • Each SecondaryURL must resolve as an https:// url (possibly http ok?)
        • Each Portal can have only one Note field
  • Every URL Should be publicly Resolveable? Even if it resolves to a "You must sign in" page
  • Standardize capitalization/punctuation?
@PsychoData PsychoData added the enhancement New feature or request label Feb 4, 2021
@PsychoData PsychoData self-assigned this Feb 4, 2021
@PsychoData
Copy link
Collaborator Author

Looking into some of this via JSON Schema which I believe may also enable Intellisense in VSCode?
At the very least, it would enable VS Code yelling at you in the Problems tab that "You cannot put a SecondaryURL field on a PortalGroup" or "You cannot specify two Note properties" et cetera. But the Schema may not work for some things like "No Duplicates"

Any other checks / tests that would be useful?

@adamfowlerit
Copy link
Owner

No other checks I can think of - the Standarize capitalization/punctuation might be hard as I've been using whatever the portal says it is, which there doesn't seem to be a standard there?

@adamfowlerit
Copy link
Owner

@PsychoData Feel like giving this a shot? All those checks would be great.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement New feature or request
Projects
None yet
Development

No branches or pull requests

2 participants