Skip to content
This repository was archived by the owner on Sep 2, 2025. It is now read-only.

Commit eafc0b3

Browse files
Update README.md
Corrected the syntax for notes and the striking out of text.
1 parent ddd0224 commit eafc0b3

File tree

1 file changed

+16
-14
lines changed

1 file changed

+16
-14
lines changed

README.md

Lines changed: 16 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
# Splunk Observability Cloud Documentation - Archived
22

3-
[![No Maintenance Intended](http://unmaintained.tech/badge.svg)](http://unmaintained.tech/)
3+
[![ARCHIVED/NO LONGER MAINTAINED](http://unmaintained.tech/badge.svg)](http://unmaintained.tech/)
44

55
> [!IMPORTANT]
66
> This repository, public-o11y-docs, will soon be archived and transitioned to a read-only
@@ -47,40 +47,42 @@ We sincerely appreciate your understanding and cooperation during this transitio
4747

4848
## Content (Deprecated)
4949

50-
[! NOTE] The documentation has moved to https://help.splunk.com/en/splunk-observability-cloud and is no longer based on the reStructuredText files found in this repository as of May 28, 2025.
50+
> [!NOTE]
51+
> The documentation has moved to https://help.splunk.com/en/splunk-observability-cloud and is no longer based on the reStructuredText files found in this repository as of May 28, 2025.
5152
52-
~This repository contains the code and documentation for our old doc site at [https://docs.splunk.com/Observability](https://docs.splunk.com/observability/en/).
53+
~This repository contains the code and documentation for our old doc site at [https://docs.splunk.com/Observability](https://docs.splunk.com/observability/en/).~
5354

54-
A private mirror exists where the Splunk technical writers edit documentation for new and updated features. The public and the private repositories update each other automatically using [repo-sync](https://github.com/repo-sync/repo-sync).~
55+
~A private mirror exists where the Splunk technical writers edit documentation for new and updated features. The public and the private repositories update each other automatically using [repo-sync](https://github.com/repo-sync/repo-sync).~
5556

5657

5758
### Contribute to the documentation (Deprecated)
5859

59-
[! NOTE] You can no longer directly contribute to the documentation through a GitHub pull request. You can still submit feedback through a form on our documentation pages. See [Providing feedback in the future](#providing-feedback-in the-future).
60+
> [!NOTE]
61+
> You can no longer directly contribute to the documentation through a GitHub pull request. You can still submit feedback through a form on our documentation pages. See [Providing feedback in the future](#providing-feedback-in the-future).
6062
6163
~Docs contributions are welcome. See [CONTRIBUTING.md](CONTRIBUTING.md) for the contribution guidelines.~
6264

6365

6466
### Requirements (Deprecated)
6567

66-
~The documentation is built from [reStructuredText](https://docutils.sourceforge.io/rst.html) files using [Sphinx](https://www.sphinx-doc.org/en/master/).
68+
~The documentation is built from [reStructuredText](https://docutils.sourceforge.io/rst.html) files using [Sphinx](https://www.sphinx-doc.org/en/master/).~
6769

68-
To contribute to the documentation you need a GitHub account. See [CONTRIBUTING.md](CONTRIBUTING.md) for our contribution guidelines.
70+
~To contribute to the documentation you need a GitHub account. See [CONTRIBUTING.md](CONTRIBUTING.md) for our contribution guidelines.~
6971

70-
To build the documentation on your machine use the Docker container in this repository, which provides a configured Python environment. To run the container you need Docker Desktop or a compatible container runtime.~
72+
~To build the documentation on your machine use the Docker container in this repository, which provides a configured Python environment. To run the container you need Docker Desktop or a compatible container runtime.~
7173

7274
#### Install the docs on your machine (Deprecated)
7375

74-
~Follow these steps to fork this repo and install it on your machine:
76+
~Follow these steps to fork this repo and install it on your machine:~
7577

76-
1. Clone this repository using `git clone`.
77-
2. Navigate to the cloned repository in your file system.
78-
3. Change the permissions of `start.sh` by entering `chmod +x start.sh` in the terminal.~
78+
~1. Clone this repository using `git clone`.~
79+
~2. Navigate to the cloned repository in your file system.~
80+
~3. Change the permissions of `start.sh` by entering `chmod +x start.sh` in the terminal.~
7981

8082
### License (Deprecated)
8183

8284
~This Splunk repository is subject to the Splunk Websites Terms and Conditions of Use ("Terms")
8385
[https://www.splunk.com/en_us/legal/terms/terms-of-use.html](https://www.splunk.com/en_us/legal/terms/terms-of-use.html)
84-
and the [LICENSE](LICENSE) specific to this repository.
86+
and the [LICENSE](LICENSE) specific to this repository.~
8587

86-
You can contribute new documentation and edits to the existing documentation.~
88+
~You can contribute new documentation and edits to the existing documentation.~

0 commit comments

Comments
 (0)