Skip to content

Commit

Permalink
📔✨:restore handbook/styleguide/devdocs conventions
Browse files Browse the repository at this point in the history
Where the manual of style belongs.

Fixes: #1111
Signed-off-by: Derek Lewis <dereknongeneric@open.inf.is>
  • Loading branch information
DerekNonGeneric authored and OpenINFbot committed Feb 2, 2024
1 parent aea61b7 commit 3f187a8
Show file tree
Hide file tree
Showing 6 changed files with 674 additions and 0 deletions.
126 changes: 126 additions & 0 deletions _layouts/handbook-content--g-devdocs-style.html
Original file line number Diff line number Diff line change
@@ -0,0 +1,126 @@
---
layout: default
---

<main role="main" class="devsite-main-content">
<div class="devsite-content">
<article class="devsite-article">
{%- if page.editable != false -%}
<div class="improve right">
<a href="https://github.com/openinf/.github/edit/HEAD/{{ page.path }}"
>Edit</a
>
</div>
{%- endif -%}
<h1 class="devsite-page-title">{{ page.title }}</h1>
<div class="devsite-article-body clearfix">
<aside id="key-point">
<p><strong>Key Point:</strong> {{ page.key_point }}</p>
</aside>
{{ content }}
</div>
</article>
<div class="devsite-content-footer nocontent">
<div class="row cc-footer-license">
<div class="license-icons">
<a
rel="license nofollow noopener noreferrer"
target="_blank"
href="https://creativecommons.org/licenses/by/4.0/"
title="Creative Commons Attribution 4.0 International license"
>
<img
class="cc-icon-cc"
src="https://raw.githubusercontent.com/DerekNonGeneric/loader339/main/doc/img/cc_icon.svg?sanitize=true"
alt="CC logo icon"
title="Creative Commons icon"
/>
<img
class="cc-icon-cc-by"
src="https://raw.githubusercontent.com/DerekNonGeneric/loader339/main/doc/img/cc-by_icon.svg?sanitize=true"
alt="CC BY icon"
title="Attribution icon"
/>
</a>
</div>
<aside>
<div
xmlns:cc="https://creativecommons.org/ns#"
about="https://creativecommons.org"
>
<p dir="auto">
<small
>Portions of this document are reproduced from work created and
<a
target="_blank"
href="https://developers.google.com/site-policies"
title="Google Developers Site Policies"
rel="nofollow noopener noreferrer"
>shared by Google</a
>
and used according to terms described in
<a
target="_blank"
href="https://creativecommons.org/licenses/by/4.0/"
title="Creative Commons Attribution 4.0 International license (CC BY 4.0)"
rel="license nofollow noopener noreferrer"
>CC BY 4.0</a
>. For more information, refer to the
<a
target="_blank"
href="{{ page.original_url }}"
title="{{ page.original_title }}"
rel="nofollow noopener noreferrer"
>original source page</a
>.</small
>
</p>
</div>
</aside>
</div>
<div class="row cc-footer-license">
<div class="license-icons">
<a
rel="license nofollow noopener noreferrer"
target="_blank"
href="https://creativecommons.org/licenses/by/4.0/"
title="Creative Commons Attribution 4.0 International license"
>
<img
class="cc-icon-cc"
src="https://raw.githubusercontent.com/DerekNonGeneric/loader339/main/doc/img/cc_icon.svg?sanitize=true"
alt="CC logo icon"
title="Creative Commons icon"
/>
<img
class="cc-icon-cc-by"
src="https://raw.githubusercontent.com/DerekNonGeneric/loader339/main/doc/img/cc-by_icon.svg?sanitize=true"
alt="CC BY icon"
title="Attribution icon"
/>
</a>
</div>
<aside>
<div
xmlns:cc="https://creativecommons.org/ns#"
about="https://creativecommons.org"
>
<p dir="auto">
<small
>Except as otherwise noted, this content is published under
<a
target="_blank"
href="https://creativecommons.org/licenses/by/4.0/"
title="Creative Commons Attribution 4.0 International license (CC BY 4.0)"
rel="license nofollow noopener noreferrer"
>CC BY 4.0</a
>.</small
>
</p>
</div>
</aside>
</div>
<p>Last updated {{ "today" | date: "%Y-%m-%d }} UTC.</p>
</div>
</div>
</main>
37 changes: 37 additions & 0 deletions collections/_docs/handbook/setup-windows/Readme.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,37 @@
---
title: Section on Windows Server Workstation Setup
category: Documentation
content_type: Install & Setup
published: false
---

<!-- Begin GitHub-Flavored Markdown (GFM)
See: https://docs.github.com/get-started/writing-on-github
Spec: https://github.github.com/gfm
-->

# Windows Server Workstation Setup

This section deals with preparing devices for (and installing) Windows Server as
the host OS for modern software development workstations.

Although using Windows may not be a requirement for contributions, many have
made the conscious decision not to go with the more common locked-down option of
Apple products. Oftentimes, the hardware associated with the machine has the
most compatibility with drivers specifically made for Windows while Linux driver
support may be limited or non-existent in some cases.

Windows as a software development workstation using one of the "Home" or
"Professional" offerings has been a notoriously bad decision due to unexpected
updates forcing the reboot at inconvenient times and which is something that the
Server offerings are more prepared to avoid having this happen.

Of the Windows Server offerings, the Desktop Experience varietal is the only
feasible choice as dealing with multimedia is often involved.

Refer to the [Get started with Windows Server][] article to learn more about how
to go about acquiring and installing it on your (hopefully) compatible system.
Regardless of stated minimum system requirements, no less than 16gb of RAM would
be recommended.

[Get started with Windows Server]: https://learn.microsoft.com/en-us/windows-server/get-started/get-started-with-windows-server
112 changes: 112 additions & 0 deletions collections/_docs/handbook/setup-windows/chapter-0/Readme.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,112 @@
---
title: Connecting to the Interwebs (Wireless Networking)
category: Documentation
content_type: Install & Setup
published: false
---

<!-- Begin GitHub-Flavored Markdown (GFM)
See: https://docs.github.com/get-started/writing-on-github
Spec: https://github.github.com/gfm
-->

<!-- Not covered: Preparing device for (and installing) host OS --
Windows Server 2016/2022 Standard with Desktop Experience.
Windows Server 2016 Standard is for physical or minimally-virtualized
environments.
See: https://www.microsoft.com/en-us/d/windows-server-2016-standard/dg7gmgf0ds12/0004
-->

Before we can begin using our Windows Server machine as an effective software
development environment, there are a few hurdles to overcome. This chapter deals
with enabling and configuring connectivity to the Internet.

## Access to Wireless Communication

As a safe default &mdash; on fresh installations of Windows Server &mdash;
wireless connectivity (such as Wi-Fi, cellular, and Bluetooth) is still
inaccessible because Airplane mode is enabled.

![image](https://user-images.githubusercontent.com/17770407/227342179-50a79652-193f-4c5c-bab2-a7571e84301d.png)

### Configuring Radio Management Service (RmSvc)[^1]

Airplane mode is also grayed-out/unconfigurable (the default preference of
"enabled" cannot be changed). The following commands must be run in an elevated
Command Line Shell prompt to modify this preference.

The following may be run in Windows Command Prompt (`cmd.exe`), which is
accessible via:

Start -> Windows System -> Command Prompt

```cmd
SC CONFIG RmSvc START= AUTO
```

You should expect to see the following output.

```console
[SC] ChangeServiceConfig SUCCESS
```

### Installing the Wireless Networking Feature

Next, we will be installing a Windows Feature.

The following may be run in PowerShell, which is accessible via

Start -> Windows PowerShell -> Windows PowerShell.

```ps
Install-WindowsFeature -Name Wireless-Networking
```

You should expect to see the following output.

```text
Success Restart Needed Exit Code Feature Result
------- -------------- --------- --------------
True Yes SuccessRest... {Wireless LAN Service}
WARNING: You must restart this server to finish the installation process.
```

To heed the warning, which indicates that a system reboot will be necessary,
the following command line may be run (using the same PowerShell session should
be alright).

```ps
shutdown –f –r –t 0
```

Once the system has reboot, start the `WlanSvc` service.

### Starting the `WlanSvc` Service

The following may be run in PowerShell, which is accessible via

Start -> Windows PowerShell -> Windows PowerShell.

```ps
Start-Service WlanSvc –PassThru
```

Once this has all been completed, it may be possible that wireless connectivity
is still inaccessible.

<img width="601" alt="we-couldnt-find-wireless-devices-on-this-pc" src="https://user-images.githubusercontent.com/17770407/227344556-df034cfb-a1b4-40e2-aae4-d87b9abf4687.PNG">

The remedy for this is to install the appropriate drivers for the wireless
adapter(s) of your device.

<!--
https://www.intel.com/content/www/us/en/download/19351/windows-10-and-windows-11-wi-fi-drivers-for-intel-wireless-adapters.html
https://support.lenovo.com/us/en/downloads/ds503062-fibocom-l850-gl-wireless-wan-driver-for-windows-10-version-1709-or-later-thinkpad
-->

[^1]: https://github.com/MicrosoftDocs/windowsserverdocs/blob/main/WindowsServerDocs/security/windows-services/security-guidelines-for-disabling-system-services-in-windows-server.md#radio-management-service

0 comments on commit 3f187a8

Please sign in to comment.