Skip to content

Commit

Permalink
Merge pull request #295 from vmware/fix/293-documentation-java-versio…
Browse files Browse the repository at this point in the history
…n-update

[documentation] (#293) Required Java version updated to Java 17 in the documentation.
  • Loading branch information
VenelinBakalov committed Jul 1, 2024
2 parents a2e4d1b + 164faf7 commit b2ddc31
Show file tree
Hide file tree
Showing 76 changed files with 2,213 additions and 1,638 deletions.
12 changes: 9 additions & 3 deletions docs/Templates/Basic.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,23 +2,29 @@

[//]: # (Remove Comments when you are done)
[//]: # (What is this?)

# Title

[//]: # (Additional Information on the topic goes here)

[//]: # (What will you learn)
[//]: # (Optional)

## Overview

[//]: # (Internal navigation)
[//]: # (Navigational links may have a short description after them separated by a `-`)
## Table Of Contents:

## Table Of Contents

1. [Section](#section)

[//]: # (Fill As many of these as you need. Use h4 and further here, do not include h1s, h2s or h3s.)

### Section

[//]: # (Optional Section)
[//]: # (## Previous:)
[//]: # (## Previous)

[//]: # (Optional Section)
[//]: # (## Next:)
[//]: # (## What's Next)
6 changes: 5 additions & 1 deletion docs/Templates/Entry.md
Original file line number Diff line number Diff line change
@@ -1,12 +1,16 @@
[//]: # (Used just for navigation, should not have any information beside very basic one)
[//]: # (If you need to add information to an entry it needs to be moved outside to a different folder)
[//]: # (Change the title)

# Entry

[//]: # (Additional Information on the entry goes here)

[//]: # (What will you learn)

## Overview

[//]: # (External navigation)
[//]: # (Navigational links may have a short description after them separated by a `-`)
## Navigation:

## Navigation
11 changes: 9 additions & 2 deletions docs/Templates/Migration.md
Original file line number Diff line number Diff line change
@@ -1,19 +1,26 @@
# Migration XXX - YYY

[//]: # (Used when placing migrations inside of the Migration folder)
[//]: # (Describe the migration)
# Migration XXX - YYY

## Prerequisites

[//]: # (Describe what state before start)

[//]: # (Describe which environment this is targeting)
## Environment

## Environment

[//]: # (Cli tools versions, third party systems state, like jfrog, azure devops, etc. further details...)

### Steps

#### Step One

[//]: # (Provide details)

[//]: # (Optional:)

## Post-Migration Action Items

[//]: # (What must be done after migration)
11 changes: 7 additions & 4 deletions docs/Templates/Release.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,26 +5,29 @@
[//]: # (Quick Intro to what is the focus of this release)

## Breaking Changes

[//]: # (### *Breaking Change*)
[//]: # (Describe the breaking change AND explain how to resolve it)
[//]: # (You can utilize internal links /e.g. link to the upgrade procedure, link to the improvement|deprecation that introduced this/)


## Deprecations

[//]: # (### *Deprecation*)
[//]: # (Explain what is deprecated and suggest alternatives)


[//]: # (Features -> New Functionality)

## Features

[//]: # (### *Feature Name*)
[//]: # (Describe the feature)
[//]: # (Optional But higlhy recommended Specify *NONE* if missing)
[//]: # (#### Relevant Documentation:)


[//]: # (Improvements -> Bugfixes/hotfixes or general improvements)

## Improvements

[//]: # (### *Improvement Name* )
[//]: # (Talk ONLY regarding the improvement)
[//]: # (Optional But higlhy recommended)
Expand All @@ -36,6 +39,6 @@
[//]: # (Optional But higlhy recommended Specify *NONE* if missing)
[//]: # (#### Relevant Documentation:)


## Upgrade procedure

[//]: # (Explain in details if something needs to be done)
32 changes: 18 additions & 14 deletions docs/Templates/Version.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,21 +5,25 @@

[//]: # (Additional Information on the topic goes here)
Build Tools for VMware Aria is a tool that helps enterprises adhere to Infrastructure-as-Code principles in a wide variety
of VMware tools.
of VMware tools.

[//]: # (External navigation)
[//]: # (Navigational links may have a short description after them separated by a `-`)
## Table Of Contents:
* [Core Concepts](./General/Core Concepts.md)
* [Getting Started](./General/Getting Started.md)
* [Installation](./General/Installation.md)
* [Use Cases](./General/Use Cases)
* What's next
* [Examples](./General/Examples)
* [Cheatsheets](./General/Cheatsheets)
* [Guides](./General/Guides)
* [Known Issues](./General/Known Issues)
* [Components](./Components)
* [FAQ](./General/FAQ.md)

## Next: [Release](./Release.md)
## Table Of Contents

- [Core Concepts](./General/Core%20Concepts.md)
- [Getting Started](./General/Getting%20Started.md)
- [Installation](./General/Installation.md)
- [Use Cases](./General/Use%20Cases)
- What's next
- [Examples](./General/Examples)
- [Cheatsheets](./General/Cheatsheets)
- [Guides](./General/Guides)
- [Known Issues](./General/Known%20Issues)
- [Components](./Components)
- [FAQ](./General/FAQ.md)

## What's Next

See [Release](./Release.md).
Loading

0 comments on commit b2ddc31

Please sign in to comment.