Skip to content

Commit 5724751

Browse files
committed
Consolidate documentation
- collapse duplicate powershell moduled READMEs - replace empty "moved to wiki" markdown files with a section in README.md
1 parent bb54829 commit 5724751

8 files changed

+24
-65
lines changed
Lines changed: 14 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,4 @@
1+
# BOSH Powershell Modules
12
Powershell scripts to set up a Windows VM in a manner appropriate for a BOSH Stemcell.
23

34
## Testing
@@ -8,8 +9,13 @@ The test suite for each module currently assumes that the tests are being run wi
89

910
This requires iterating through the module directories to run all the tests:
1011

11-
```
12-
cd stembuild
12+
Two copies of BOSH Powershell Modules exist in this repo:
13+
- `stembuild/modules`
14+
- `modules`
15+
16+
```powershell
17+
# Where MODULES_DIR is ""ci/tasks/delete-vms/delete-vms.iml, or "modules"
18+
cd $MODULES_DIR
1319
foreach ($module in (Get-ChildItem "./modules").Name) {
1420
Push-Location "modules/$module"
1521
$results=Invoke-Pester -PassThru
@@ -23,21 +29,21 @@ echo "Failed Tests: $result"
2329

2430
If you just need to test a single module, you could do this:
2531

26-
```
27-
cd "stembuild\module\BOSH.<module>"
32+
```powershell
33+
cd "$MODULES_DIR\BOSH.<module>"
2834
Invoke-Pester
2935
```
3036

31-
## Running a subset of tests on MacOS
37+
## Running a subset of tests on macOS
3238

33-
You can use Powershell and MacOS to run the tests that do not require Windows system calls:
39+
You can use Powershell and macOS to run the tests that do not require Windows system calls:
3440

35-
```
41+
```shell
3642
cd ~/workspace
3743
brew install powershell
3844
git clone --depth 1 --branch 4.4.0 [email protected]:pester/Pester.git
3945
pwsh
4046
Import-Module ./Pester/Pester.psm1
4147
cd stembuild/module/BOSH.<module>
4248
Invoke-Pester
43-
```
49+
```

README-psmodules.md

Lines changed: 0 additions & 53 deletions
This file was deleted.

README.md

Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -39,3 +39,13 @@ bundle exec rspec
3939
```
4040

4141
Acceptance testing for stemcells should be done with [bosh-windows-acceptance-tests](https://github.com/cloudfoundry/bosh-windows-acceptance-tests)
42+
43+
## Relocated Documentation
44+
- azure-light-stemcell.md
45+
- https://github.com/cloudfoundry/bosh-windows-stemcell-builder/wiki/Using-the-Azure-Light-Stemcell
46+
- create-manual-openstack-stemcells.md
47+
- https://github.com/cloudfoundry/bosh-windows-stemcell-builder/wiki/Create-Manual-OpenStack-Stemcells
48+
- manual-stemcell-dotnet-version-guide.md
49+
- https://github.com/cloudfoundry/bosh-windows-stemcell-builder/wiki/Manual-Stemcell-DotNet-Version-Guide
50+
- with-concourse.md
51+
- https://github.com/cloudfoundry/bosh-windows-stemcell-builder/wiki/Windows-Worker-and-Concourse-Setup

azure-light-stemcell.md

Lines changed: 0 additions & 1 deletion
This file was deleted.

azure-marketplace.png

-203 KB
Binary file not shown.

create-manual-openstack-stemcells.md

Lines changed: 0 additions & 1 deletion
This file was deleted.

manual-stemcell-dotnet-version-guide.md

Lines changed: 0 additions & 1 deletion
This file was deleted.

with-concourse.md

Lines changed: 0 additions & 1 deletion
This file was deleted.

0 commit comments

Comments
 (0)