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

Inconsistent section ordering in baseline documents #371

Closed
schrolla opened this issue Jun 8, 2023 · 2 comments
Closed

Inconsistent section ordering in baseline documents #371

schrolla opened this issue Jun 8, 2023 · 2 comments
Assignees
Labels
baseline-document Issues relating to the text in the baseline documents themselves
Milestone

Comments

@schrolla
Copy link
Collaborator

schrolla commented Jun 8, 2023

🐛 Summary

Some of the sections are not ordered the same across the different product baseline policy documents. Specifically, the Assumptions and Resources sections are ordering is reversed in PowerBI and SharePoint compared to the others. The order of these sections across the baselines is as follows:

Baseline Ordering
AzureAD Assumptions then Resources
Defender Assumptions then Resources
Exchange Assumptions then Resources
OneDrive Assumptions then Resources
PowerBI Resources then Assumptions
PowerPlatform Assumptions then Resources
SharePoint Resources then Assumptions
Teams Assumptions then Resources

To reproduce

Steps to reproduce the behavior:

  1. View each baseline and notice the Assumptions and Resources section ordering

Expected behavior

The expectation is that the baselines have the same structure and ordering of sections to make it easier for readers to follow any of them and find relevant sections easily. The specific ordering matters less than consistency in the ordering.

@schrolla schrolla added the baseline-document Issues relating to the text in the baseline documents themselves label Jun 8, 2023
@schrolla schrolla added this to the Emerald milestone Jun 8, 2023
@ahuynhMITRE
Copy link
Collaborator

Suggestion to update markdowns to be ordered Assumptions then Resources due to the majority of the baselines being ordered in this fashion. Also a suggestion to add this to #212 since it can be viewed as a structural adjudication task.

@ahuynhMITRE ahuynhMITRE self-assigned this Jun 15, 2023
@schrolla
Copy link
Collaborator Author

@ahuynhMITRE Based on the updated formatting, there is no resources section in any of the documents as part of the front matter anymore. Defender still shows a bad header, but I'm fixing that as part of other changes. So I think this one can be closed out.

@schrolla schrolla closed this as completed Sep 8, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
baseline-document Issues relating to the text in the baseline documents themselves
Projects
None yet
Development

No branches or pull requests

2 participants