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

Commit ddd0224

Browse files
Update README.md
Added a banner, notes, and struck out the old instructions.
1 parent 4f2d61e commit ddd0224

File tree

1 file changed

+19
-12
lines changed

1 file changed

+19
-12
lines changed

README.md

Lines changed: 19 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,7 @@
11
# Splunk Observability Cloud Documentation - Archived
22

3+
[![No Maintenance Intended](http://unmaintained.tech/badge.svg)](http://unmaintained.tech/)
4+
35
> [!IMPORTANT]
46
> This repository, public-o11y-docs, will soon be archived and transitioned to a read-only
57
> state as part of our migration to a new authoring and publishing platform. We would
@@ -27,53 +29,58 @@ Contribution permissions will be limited to Collaborators and Organization membe
2729

2830
The repository will be officially archived and transitioned to a read-only state.
2931

30-
## What Happens After Archival
32+
## What Happens After Archiving
3133

3234
Once the repository is archived:
3335

3436
* It will remain accessible in a read-only state for reference purposes.
3537
* No further pull requests (PRs), issues, or contributions will be accepted.
3638
* The repository’s history will remain available for cloning and viewing but will no longer allow modifications.
3739

38-
## Moving Forward
40+
## Providing feedback in the future
3941

40-
We encourage all contributors to refer to the new platform for future contributions and updates. If you have any questions regarding this transition or require assistance, please contact us at splunk-o11y-cloud-docs@external.cisco.com.
42+
We encourage all contributors to refer to the new platform for future contributions and updates. If you have any questions regarding this transition or require assistance, please contact us at [email protected].
4143

4244
We sincerely appreciate your understanding and cooperation during this transition period.
4345

4446
---
4547

4648
## Content (Deprecated)
4749

48-
This repository contains the code and documentation for https://docs.splunk.com/Observability
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.
51+
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/).
4953

50-
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).
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).~
5155

5256

5357
### Contribute to the documentation (Deprecated)
5458

55-
Docs contributions are welcome. See [CONTRIBUTING.md](CONTRIBUTING.md) for the contribution guidelines.
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+
61+
~Docs contributions are welcome. See [CONTRIBUTING.md](CONTRIBUTING.md) for the contribution guidelines.~
62+
5663

5764
### Requirements (Deprecated)
5865

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

6168
To contribute to the documentation you need a GitHub account. See [CONTRIBUTING.md](CONTRIBUTING.md) for our contribution guidelines.
6269

63-
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.
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.~
6471

6572
#### Install the docs on your machine (Deprecated)
6673

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

6976
1. Clone this repository using `git clone`.
7077
2. Navigate to the cloned repository in your file system.
71-
3. Change the permissions of `start.sh` by entering `chmod +x start.sh` in the terminal.
78+
3. Change the permissions of `start.sh` by entering `chmod +x start.sh` in the terminal.~
7279

7380
### License (Deprecated)
7481

75-
This Splunk repository is subject to the Splunk Websites Terms and Conditions of Use ("Terms")
82+
~This Splunk repository is subject to the Splunk Websites Terms and Conditions of Use ("Terms")
7683
[https://www.splunk.com/en_us/legal/terms/terms-of-use.html](https://www.splunk.com/en_us/legal/terms/terms-of-use.html)
7784
and the [LICENSE](LICENSE) specific to this repository.
7885

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

0 commit comments

Comments
 (0)