Skip to content

Commit

Permalink
readthedocs implementation
Browse files Browse the repository at this point in the history
  • Loading branch information
techthoughts2 committed Dec 14, 2023
1 parent df8d7c6 commit 88780ff
Show file tree
Hide file tree
Showing 5 changed files with 22 additions and 58 deletions.
3 changes: 0 additions & 3 deletions .github/SECURITY.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,13 +2,10 @@

## Reporting a Vulnerability

<<<<<<< HEAD
=======
<!--- Use this section to tell people how to report a vulnerability.
Tell them where to go, how often they can expect to get an update on a reported vulnerability, what to expect if the vulnerability is accepted or declined, etc. -->

>>>>>>> Enhancements
If you discover a vulnerability in pwshCloudCommands, please follow the _following process_:

1. Open a generic bug issue advising you have discovered a vulnerability.
Expand Down
4 changes: 0 additions & 4 deletions LICENSE
Original file line number Diff line number Diff line change
@@ -1,10 +1,6 @@
MIT License

<<<<<<< HEAD
Copyright (c) 2023 Jake Morrison
=======
Copyright (c) 2024 Jake
>>>>>>> Enhancements

Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
Expand Down
12 changes: 0 additions & 12 deletions actions_bootstrap.ps1
Original file line number Diff line number Diff line change
Expand Up @@ -11,20 +11,12 @@ $modulesToInstall = [System.Collections.ArrayList]::new()
# https://github.com/pester/Pester
$null = $modulesToInstall.Add(([PSCustomObject]@{
ModuleName = 'Pester'
<<<<<<< HEAD
ModuleVersion = '5.4.0'
=======
ModuleVersion = '5.5.0'
>>>>>>> Enhancements
}))
# https://github.com/nightroman/Invoke-Build
$null = $modulesToInstall.Add(([PSCustomObject]@{
ModuleName = 'InvokeBuild'
<<<<<<< HEAD
ModuleVersion = '5.10.2'
=======
ModuleVersion = '5.10.4'
>>>>>>> Enhancements
}))
# https://github.com/PowerShell/PSScriptAnalyzer
$null = $modulesToInstall.Add(([PSCustomObject]@{
Expand All @@ -41,11 +33,7 @@ $null = $modulesToInstall.Add(([PSCustomObject]@{
# older version used due to: https://github.com/PowerShell/platyPS/issues/457
$null = $modulesToInstall.Add(([PSCustomObject]@{
ModuleName = 'Convert'
<<<<<<< HEAD
ModuleVersion = '1.2.0'
=======
ModuleVersion = '1.5.0'
>>>>>>> Enhancements
}))


Expand Down
21 changes: 0 additions & 21 deletions docs/CHANGELOG.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,26 +5,6 @@ All notable changes to this project will be documented in this file.
The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).

<<<<<<< HEAD
## [Not Released]

- Build Updates:
- GitHub Actions CI/CD changes:
- Build will now ignore `docs` folder and all `.md` file updates. Builds will not be triggered if only these are updated.
- Updated `checkout@v2` to `checkout@v3`
- Updated `upload-artifact@v2` to `upload-artifact@v3`
- Moved `CHANGELOG.md` from `.github` directory to `docs` directory
- Updated VSCode `tasks.json`
- Added a `SECURITY.md` file for the project
- Updated buildspec files to dotnet 6.0
- Updated `install_modules.ps1` - removed modules not used and bumped module versions
- CodeBuild now uses PSGallery for module installs
- Updated CloudFront Distribution from OriginAccessIdentity to OriginAccessControl
- Removed un-used SSM Hybrid role
- Updated tags on infra
- Updated CodeBuild Linux image from `aws/codebuild/standard:5.0` to `aws/codebuild/standard:6.0`
- Added log retention groups to all CodeBuild projects
=======
## [1.0.0]

- Module Changes
Expand Down Expand Up @@ -55,7 +35,6 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
- Updated `tasks.json` for cleaner references and additional tasks
- Updated `LICENSE` year
- Added metric dashboards to docs section
>>>>>>> Enhancements

## [0.8.0]

Expand Down
40 changes: 22 additions & 18 deletions mkdocs.yml
Original file line number Diff line number Diff line change
Expand Up @@ -10,38 +10,38 @@

site_name: pwshCloudCommands
# site_url:
# repo_url:
repo_url: https://github.com/techthoughts2/pwshCloudCommands
# repo_name:
# edit_uri: edit/main/docs/
# edit_uri_template:
site_description: Search, discover, and identify PowerShell cloud commands across multiple cloud providers. # meta tag to the generated HTML header
site_author: Jake # meta tag to the generated HTML header
# copyright:
site_author: Jake Morrison # meta tag to the generated HTML header
copyright: "pwshCloudCommands is licensed under the <a href='https://github.com/techthoughts2/pwshCloudCommands/blob/main/LICENSE'>MIT license"
# remote_branch:
# remote_name:
# docs_dir: docs
# site_dir:
# extra_css:
# extra_javascript:
# markdown_extensions:
markdown_extensions:
# Python Markdown
# - admonition
# - toc:
# permalink: true
- admonition
- toc:
permalink: true
# code highlighting
# - pymdownx.highlight:
# use_pygments: true
# - pymdownx.highlight:
# anchor_linenums: true
# - pymdownx.inlinehilite
# - pymdownx.snippets
# - pymdownx.superfences
- pymdownx.highlight:
use_pygments: true
- pymdownx.highlight:
anchor_linenums: true
- pymdownx.inlinehilite
- pymdownx.snippets
- pymdownx.superfences

# extra_templates:
# extra:
theme:
name: material
# language: en
language: en
# custom_dir: overrides
features:
# - navigation.tabs
Expand Down Expand Up @@ -75,7 +75,11 @@ theme:
# name: Switch to light mode
nav:
- Home: index.md
- Functions:
- Find-CloudCommand: Find-CloudCommand.md
- Get-AllCloudCommandInfo: Get-AllCloudCommandInfo.md
- Get-CloudCommandFromFile: Get-CloudCommandFromFile.md
- Metrics: pwshCloudCommand-Metrics.md
- FAQ: pwshCloudCommand-FAQ.md
- Cache Design: pwshCloudCommands_cache_workflow.md
- Change Log: CHANGELOG.md
# - Functions:
# - Function1: functions/function1.md

0 comments on commit 88780ff

Please sign in to comment.