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

Add links to setting up service principal to the ScubaGear Functional Testing Automation instructions document #1368

Open
1 task
tkol2022 opened this issue Oct 21, 2024 · 1 comment · May be fixed by #1423
Assignees
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
Milestone

Comments

@tkol2022
Copy link
Collaborator

tkol2022 commented Oct 21, 2024

Scope

There is a markdown document in the /Testing folder that details how to execute the functional test orchestrator as a user. The document is named "ScubaGear Functional Testing Automation". The scope of this issue is to add the links below to that document for easy reference. The links below are documentation issues that I had created which describe how to setup the service principal used by the automated functional test orchestrator in GitHub and by ScubaGear developers. Those links also describe how to setup the respective conditional access policies that are necessary when running the functional test orchestrator against the Entra Id baseline.

Justification

The reason this is helpful is because these issues are closed and we need to refer back to them every so often when fixing configurations in the tenant or setting up a new testing configuration and this will make it much easier to find them instead of having to search the old closed issues list.

Implementation

  • Create a new section in the testing instructions document (this section is for sys admins). Call it Functional Testing Infrastructure Setup or something like that. Add the links above
@tkol2022 tkol2022 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 Oct 21, 2024
@schrolla schrolla added this to the Kraken milestone Oct 21, 2024
@tkol2022 tkol2022 assigned ehaines1 and unassigned tkol2022 Oct 31, 2024
@tkol2022
Copy link
Collaborator Author

I received internal feedback from the dev team with a recommendation on how to implement this. I think this is a good approach. Their feedback is included below for reference. If there are any questions please contact @james-garriss for context and further recommendations.

  • Create a new subfolder under Testing called docs.
    Image

  • Create Markdown files in there with the documentation from the two hyperlinks in the Scope section above. This is basically converting the information from GitHub issues to markdown files.
    Image

  • Create a new section in the /Testing/Readme.md file named Setup Documentation for Sys Admins

  • Add hyperlinks and a quick description of the two new markdown files into the new Setup Documentation for Sys Admins section.

@ehaines1 ehaines1 linked a pull request Nov 13, 2024 that will close this issue
18 tasks
@ehaines1 ehaines1 linked a pull request Nov 13, 2024 that will close this issue
18 tasks
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 a pull request may close this issue.

3 participants