Skip to content

Commit 2b61d8d

Browse files
nkoenigNate Koenig
and
Nate Koenig
authored
[14] Rename ignition in readme, and yaml files (#269)
* Rename Ignition to Gazebo in ci.md Signed-off-by: Nate Koenig <[email protected]> * Rename Ignition to Gazebo in contributing.md Signed-off-by: Nate Koenig <[email protected]> * Rename Ignition to Gazebo in release_features.md Signed-off-by: Nate Koenig <[email protected]> * Rename ignition to gazebo in release.md Signed-off-by: Nate Koenig <[email protected]> * Rename ignition in readme, and yaml files Signed-off-by: Nate Koenig <[email protected]> * Update releases.md Signed-off-by: Nate Koenig <[email protected]> Co-authored-by: Nate Koenig <[email protected]>
1 parent a739fe3 commit 2b61d8d

File tree

4 files changed

+22
-22
lines changed

4 files changed

+22
-22
lines changed

README.md

+7-7
Original file line numberDiff line numberDiff line change
@@ -1,17 +1,17 @@
1-
# Ignition Documentation
1+
# Gazebo Documentation
22

3-
This repository contains documentation about [Ignition](https://gazebosim.org) that does not pertain to a specific
4-
[Ignition library](https://gazebosim.org/libs). An example would be
5-
installation instructions for an Ignition release. The documentation
3+
This repository contains documentation about [Gazebo](https://gazebosim.org) that does not pertain to a specific
4+
[Gazebo library](https://gazebosim.org/libs). An example would be
5+
installation instructions for an Gazebo release. The documentation
66
contained in this repository can be view at
77
[https://gazebosim.org/docs](https://gazebosim.org/docs).
88

9-
Each [Ignition library](https://gazebosim.org/libs) maintains
9+
Each [Gazebo library](https://gazebosim.org/libs) maintains
1010
documentation and tutorials that are scoped to the features and
1111
capabilities of the library itself. The documentation for a library can be
1212
found under the `API Reference` section of [https://gazebosim.org/docs](https://gazebosim.org/docs).
1313

14-
## Updating ignitionrobotics.org
14+
## Updating gazebosim.org
1515

1616
## Main docs
1717

@@ -22,4 +22,4 @@ serves the markdown pages to https://gazebosim.org.
2222
## Library docs
2323

2424
Instructions on how to update all of the library docs is contained in the
25-
[tools/build_docs.sh](https://github.com/ignitionrobotics/docs/blob/master/tools/build_docs.sh) script.
25+
[tools/build_docs.sh](https://github.com/gazebosim/docs/blob/master/tools/build_docs.sh) script.

index.yaml

+6-6
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
# This file is an index of the pages to display on the documentation website
2-
# (https://ignitionrobotics.org/docs). The order of the pages in this file
2+
# (https://gazebosim.org/docs). The order of the pages in this file
33
# is reflected on the website's left sidebar.
44
#
55
# Components of the index:
@@ -18,27 +18,27 @@ pages:
1818
- name: getstarted
1919
title: Get Started
2020
file: get_started.md
21-
description: Getting started with Ignition.
21+
description: Getting started with Gazebo.
2222
- name: roadmap
2323
title: Roadmap
2424
file: roadmap.md
2525
description: Our development plans.
2626
- name: release-features
2727
title: Release Features
2828
file: release_features.md
29-
description: Features available in each Ignition release.
29+
description: Features available in each Gazebo release.
3030
- name: releases
3131
title: Releases
3232
file: releases.md
3333
description: Past, current, and future release information.
3434
- name: contributing
3535
title: Contributing
3636
file: contributing.md
37-
description: How to contribute to Ignition.
37+
description: How to contribute to Gazebo.
3838
- name: architecture
3939
title: Architecture
4040
file: architecture.md
41-
description: Ignition Gazebo's architecture overview.
41+
description: Gazebo Gazebo's architecture overview.
4242
unlisted: true
4343
- name: release
4444
title: Release process
@@ -78,4 +78,4 @@ releases:
7878
- name: acropolis
7979
lts: false
8080
eol: true
81-
description: Ignition's first release.
81+
description: Gazebo's first release.

releases.md

+8-8
Original file line numberDiff line numberDiff line change
@@ -1,14 +1,14 @@
1-
# Ignition Releases
1+
# Gazebo Releases
22

33
This page details the set of past and planned releases.
44

55
## What is a Release?
66

7-
A release of Ignition consists of a set of versioned [Ignition Libraries](/libs). Each library follows [semantic versioning](https://semver.org), and the major version of a library is guaranteed not to change with an Ignition release. This essentially means you can develop code against a release of Ignition without the worry of breaking changes being made upstream.
7+
A release of Gazebo consists of a set of versioned [Gazebo Libraries](/libs). Each library follows [semantic versioning](https://semver.org), and the major version of a library is guaranteed not to change with an Gazebo release. This essentially means you can develop code against a release of Gazebo without the worry of breaking changes being made upstream.
88

99
### Naming Scheme
1010

11-
An Ignition release follows the form "Ignition Codename", for example Ignition Acropolis. The codename is alphabetically increasing, and chosen to fall loosely within the architectural domain.
11+
A Gazebo release follows the form "Gazebo Codename", for example Gazebo Acropolis. The codename is alphabetically increasing, and chosen to fall loosely within the architectural domain.
1212

1313
## Release List
1414

@@ -21,12 +21,12 @@ An Ignition release follows the form "Ignition Codename", for example Ignition A
2121
| [Edifice](https://gazebosim.org/docs/edifice) | Mar, 2021 | Mar, 2022 | EOL |
2222
| [Fortress](https://gazebosim.org/docs/fortress) | Sep, 2021 | Sep, 2026 | LTS |
2323
| [Garden](https://gazebosim.org/docs/garden) | Sep, 2022 | Sep, 2024 | |
24-
| Ignition-H | Sep, 2023 | Sep, 2028 | LTS |
25-
| Ignition-I | Sep, 2024 | Sep, 2026 | |
24+
| Gazebo-H | Sep, 2023 | Sep, 2028 | LTS |
25+
| Gazebo-I | Sep, 2024 | Sep, 2026 | |
2626

2727
## Library Versions
2828

29-
Ignition adheres to [semantic versioning](https://semver.org), with the
29+
Gazebo adheres to [semantic versioning](https://semver.org), with the
3030
addition that ABI is considered part of the public interface. In summary:
3131

3232
* **Major** version increased when incompatible ABI/API changes are made.
@@ -55,7 +55,7 @@ Ign-(N+2) | void bar();
5555

5656
### Support lifecycle
5757

58-
Check out [this table](https://github.com/ignitionrobotics/docs/blob/master/tools/versions.md)
58+
Check out [this table](https://github.com/gazebosim/docs/blob/master/tools/versions.md)
5959
for a list of release and EOL dates for all versions of all libraries.
6060

6161
### Supported platforms
@@ -64,7 +64,7 @@ Platforms are defined as a combination of operating system and architecture.
6464
For example, "Ubuntu Focal on amd64".
6565

6666
Each release is targeted at a specific set of platforms. A support level applies
67-
to an entire Ignition release, including all library versions within it. The
67+
to an entire Gazebo release, including all library versions within it. The
6868
supported platforms for each release are listed on their home pages (i.e.
6969
[Fortress](https://gazebosim.org/docs/fortress)).
7070

tutorials.yaml

+1-1
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
# This file is an index of the pages to display on the documentation website
2-
# (https://ignitionrobotics.org/tutorials). The order of the pages in this file
2+
# (https://gazebosim.org/tutorials). The order of the pages in this file
33
# is reflected on the website's left sidebar.
44

55
releases:

0 commit comments

Comments
 (0)