Skip to content

Commit 74cabd6

Browse files
authored
feat(contributing): development section, testing playbook pages (#218)
1 parent c762ed8 commit 74cabd6

File tree

4 files changed

+106
-6
lines changed

4 files changed

+106
-6
lines changed

docs/contributing/playbook.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@ icon: custom/atlas
55

66
# :custom-atlas: Contributing to the Atlas Playbook
77

8-
This page will cover how to modify, test, and build Atlas. We highly recommend reading through the [Contribution Guidelines](contribution-guidelines.md) first!
8+
This page will cover how to modify, test, and build Atlas. If you plan to contribute, we recommend reading the [Contribution Guidelines](contribution-guidelines.md) first!
99

1010
## :material-book-search: How the Playbook works
1111

@@ -17,7 +17,7 @@ Atlas is a Playbook, and alongside [AME's documentation](https://docs.ameliorate
1717

1818
### What Atlas uses internally
1919

20-
You can learn as you go, but consider getting some familiarity with the following if you're going to directly contribute to the Playbook:
20+
You can learn as you go, but consider getting some familiarity with the following if you're going to contribute to the Playbook directly:
2121

2222
- [Visual Studio Code (VSCode)](https://code.visualstudio.com/learn)
2323
- [PowerShell scripting](https://learn.microsoft.com/en-us/powershell/scripting/learn/ps101/01-getting-started)
Lines changed: 34 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,34 @@
1+
---
2+
description: How we test the AtlasOS Playbook
3+
icon: material/help-box-multiple
4+
---
5+
6+
# :material-help-box-multiple: How to report issues when testing
7+
8+
This page tells you how to report any issues you find [when testing](what-to-test.md).
9+
10+
## :material-script-text: AME Wizard logs
11+
12+
Before reporting, we would find it useful if you could skim through your AME Wizard logs (located in `C:\ProgramData\AME\Logs`) to look for the following:
13+
14+
- The `Output.txt` from the latest Playbook
15+
- Check if there are any errors in the scripts
16+
- If there are any logical errors in the scripts
17+
- The `Log.yml`
18+
- Check if there are any errors from AME Wizard
19+
20+
If you find anything, include that in your report. However, **post all logs when reporting bugs so we can also look through them.** No personally identifiable information is contained in these, except from your Windows username.
21+
22+
## :material-alert: Where to report to
23+
24+
### If it's the latest release...
25+
26+
Please report to the [Atlas GitHub Issues](https://github.com/Atlas-OS/Atlas/issues). Ensure that you follow the issue template.
27+
28+
### If it's from a GitHub branch...
29+
30+
Ideally, report to the `📘 ┃ playbook` channel under our [Discord's 'Development' category](../../faq-and-troubleshooting/common-questions/testing-nightly-builds.md). Otherwise, report to the [Atlas GitHub Issues](https://github.com/Atlas-OS/Atlas/issues). Ensure that you follow the issue template.
31+
32+
### If it's a [preview from our Discord](../../faq-and-troubleshooting/common-questions/testing-nightly-builds.md)...
33+
34+
Report to the designated `🧪 ┃ issue-reporting` forum channel under the 'Development' category.
Lines changed: 62 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,62 @@
1+
---
2+
description: How we test the AtlasOS Playbook
3+
icon: material/test-tube
4+
---
5+
6+
# :material-test-tube: What you can test for in Atlas
7+
8+
This page covers what we recommend testing in an in-development build. See [the reporting issues page](reporting-issues.md) if you find any problems.
9+
10+
If you haven't set up a virtual machine, see the [Playbook contributing page](../playbook.md) on how to do so. However, feel free to test it on real hardware, especially if it's a [release candidate](../../faq-and-troubleshooting/common-questions/testing-nightly-builds.md)!
11+
12+
!!! note "Ensure what you test works on stock Windows first"
13+
To reduce the amount of false reports, please verify that any issues encountered on Atlas do not happen in the same environment and configuration on unmodified Windows.
14+
15+
## :octicons-person-16: Your personally used Windows features
16+
17+
Testing the features you use is recommended, especially if it's not a typical configuration or usage. Some examples of this include:
18+
19+
- Non-English languages
20+
- Multiple languages & keyboard layouts
21+
- Touchscreen support
22+
- ARM-based Windows (11 only)
23+
- Accessibility features
24+
- Hyper-V and WSL
25+
26+
## :material-gamepad: Your personally used apps/games
27+
28+
We recommend testing all your personally used software and games in a realistic environment to ensure that Atlas has brought no incompatibilities.
29+
30+
Ensure you install drivers properly beforehand and can't reproduce any encountered issues on stock Windows in the same environment.
31+
32+
## :material-update: Windows Update
33+
34+
As Atlas supports Windows Update, consider testing the following that all make use of Windows Update's components:
35+
36+
- From the [base ISO (no updates)](../playbook.md#which-snapshots-to-make), installing all Windows Updates post-Atlas
37+
- Language pack installation
38+
- Various optional Windows features
39+
- Store and XBOX game installation/updates
40+
41+
## :material-router-network: Remoting and file sharing
42+
43+
Consider testing local network features such as:
44+
45+
- Windows file sharing
46+
- Enable with the [Atlas script](../../getting-started/post-installation/atlas-folder/general-configuration.md#file-sharing) first
47+
- Ensure that it works on stock Windows
48+
- Screencasting
49+
- Remote Desktop
50+
51+
## :custom-atlas: Atlas folder
52+
53+
We recommend doing lots of testing in the Atlas folder. For this, we recommend the following:
54+
55+
- Testing each script and checking if it does its functionality
56+
- Especially the significant scripts like disabling Defender
57+
- If prompted for anything, test various inputs
58+
- Make sure to restart if prompted
59+
- Suggesting where we can:
60+
- Improve the structure
61+
- Improve user experience
62+
- Simplify the folder

mkdocs.yml

Lines changed: 8 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -22,10 +22,6 @@ nav:
2222
- Home:
2323
- Home: index.md
2424
- Branding Kit: branding.md
25-
- Contributing:
26-
- Contribution Guidelines: contributing/contribution-guidelines.md
27-
- Documentation: contributing/documentation.md
28-
- Playbook: contributing/playbook.md
2925

3026
- Getting Started:
3127
- Installation: getting-started/installation.md
@@ -88,6 +84,14 @@ nav:
8884
- Roblox not opening: faq-and-troubleshooting/common-questions/roblox-not-opening.md
8985
- FIFA/EAFC not launching: faq-and-troubleshooting/common-questions/fifa-and-eafc-not-launching.md
9086

87+
- Development:
88+
- Contribution Guidelines: contributing/contribution-guidelines.md
89+
- Documentation: contributing/documentation.md
90+
- Playbook: contributing/playbook.md
91+
92+
- Testing:
93+
- What to test: contributing/testing/what-to-test.md
94+
- Reporting issues: contributing/testing/reporting-issues.md
9195

9296
#
9397
# Theme Settings

0 commit comments

Comments
 (0)