Skip to content

feat(contributing): development section, testing playbook pages #218

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 13 commits into from
Jul 9, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 2 additions & 2 deletions docs/contributing/playbook.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@ icon: custom/atlas

# :custom-atlas: Contributing to the Atlas Playbook

This page will cover how to modify, test, and build Atlas. We highly recommend reading through the [Contribution Guidelines](contribution-guidelines.md) first!
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!

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

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

### What Atlas uses internally

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

- [Visual Studio Code (VSCode)](https://code.visualstudio.com/learn)
- [PowerShell scripting](https://learn.microsoft.com/en-us/powershell/scripting/learn/ps101/01-getting-started)
Expand Down
34 changes: 34 additions & 0 deletions docs/contributing/testing/reporting-issues.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,34 @@
---
description: How we test the AtlasOS Playbook
icon: material/help-box-multiple
---

# :material-help-box-multiple: How to report issues when testing

This page tells you how to report any issues you find [when testing](what-to-test.md).

## :material-script-text: AME Wizard logs

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:

- The `Output.txt` from the latest Playbook
- Check if there are any errors in the scripts
- If there are any logical errors in the scripts
- The `Log.yml`
- Check if there are any errors from AME Wizard

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.

## :material-alert: Where to report to

### If it's the latest release...

Please report to the [Atlas GitHub Issues](https://github.com/Atlas-OS/Atlas/issues). Ensure that you follow the issue template.

### If it's from a GitHub branch...

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.

### If it's a [preview from our Discord](../../faq-and-troubleshooting/common-questions/testing-nightly-builds.md)...

Report to the designated `🧪 ┃ issue-reporting` forum channel under the 'Development' category.
62 changes: 62 additions & 0 deletions docs/contributing/testing/what-to-test.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,62 @@
---
description: How we test the AtlasOS Playbook
icon: material/test-tube
---

# :material-test-tube: What you can test for in Atlas

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.

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)!

!!! note "Ensure what you test works on stock Windows first"
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.

## :octicons-person-16: Your personally used Windows features

Testing the features you use is recommended, especially if it's not a typical configuration or usage. Some examples of this include:

- Non-English languages
- Multiple languages & keyboard layouts
- Touchscreen support
- ARM-based Windows (11 only)
- Accessibility features
- Hyper-V and WSL

## :material-gamepad: Your personally used apps/games

We recommend testing all your personally used software and games in a realistic environment to ensure that Atlas has brought no incompatibilities.

Ensure you install drivers properly beforehand and can't reproduce any encountered issues on stock Windows in the same environment.

## :material-update: Windows Update

As Atlas supports Windows Update, consider testing the following that all make use of Windows Update's components:

- From the [base ISO (no updates)](../playbook.md#which-snapshots-to-make), installing all Windows Updates post-Atlas
- Language pack installation
- Various optional Windows features
- Store and XBOX game installation/updates

## :material-router-network: Remoting and file sharing

Consider testing local network features such as:

- Windows file sharing
- Enable with the [Atlas script](../../getting-started/post-installation/atlas-folder/general-configuration.md#file-sharing) first
- Ensure that it works on stock Windows
- Screencasting
- Remote Desktop

## :custom-atlas: Atlas folder

We recommend doing lots of testing in the Atlas folder. For this, we recommend the following:

- Testing each script and checking if it does its functionality
- Especially the significant scripts like disabling Defender
- If prompted for anything, test various inputs
- Make sure to restart if prompted
- Suggesting where we can:
- Improve the structure
- Improve user experience
- Simplify the folder
12 changes: 8 additions & 4 deletions mkdocs.yml
Original file line number Diff line number Diff line change
Expand Up @@ -22,10 +22,6 @@ nav:
- Home:
- Home: index.md
- Branding Kit: branding.md
- Contributing:
- Contribution Guidelines: contributing/contribution-guidelines.md
- Documentation: contributing/documentation.md
- Playbook: contributing/playbook.md

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

- Development:
- Contribution Guidelines: contributing/contribution-guidelines.md
- Documentation: contributing/documentation.md
- Playbook: contributing/playbook.md

- Testing:
- What to test: contributing/testing/what-to-test.md
- Reporting issues: contributing/testing/reporting-issues.md

#
# Theme Settings
Expand Down
Loading