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

Commit 4f2d61e

Browse files
Updating the README to include a note and information about the archiving of the repository.
1 parent f5876de commit 4f2d61e

File tree

1 file changed

+51
-5
lines changed

1 file changed

+51
-5
lines changed

README.md

Lines changed: 51 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,30 +1,76 @@
1-
# Splunk Observability Cloud Documentation
1+
# Splunk Observability Cloud Documentation - Archived
2+
3+
> [!IMPORTANT]
4+
> This repository, public-o11y-docs, will soon be archived and transitioned to a read-only
5+
> state as part of our migration to a new authoring and publishing platform. We would
6+
> like to take this opportunity to thank all contributors, collaborators, and organization
7+
> members for their valuable contributions to this project. Your efforts have played
8+
> a critical role in its development and success.
9+
10+
## Key Dates and Timeline
11+
12+
### July 1st, 2025:
13+
14+
* The repository will enter maintenance mode, and no new collaborators or contributors will be added.
15+
* Only individuals with prior contributions will retain the ability to participate.
16+
17+
### July 1st – July 31st, 2025:
18+
19+
* Existing contributors may continue to create pull requests (PRs).
20+
* Contributors without prior involvement in the repository will no longer be able to participate.
21+
22+
### August 1st – August 30th, 2025:
23+
24+
Contribution permissions will be limited to Collaborators and Organization members only.
25+
26+
### August 30th, 2025:
27+
28+
The repository will be officially archived and transitioned to a read-only state.
29+
30+
## What Happens After Archival
31+
32+
Once the repository is archived:
33+
34+
* It will remain accessible in a read-only state for reference purposes.
35+
* No further pull requests (PRs), issues, or contributions will be accepted.
36+
* The repository’s history will remain available for cloning and viewing but will no longer allow modifications.
37+
38+
## Moving Forward
39+
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 [email protected].
41+
42+
We sincerely appreciate your understanding and cooperation during this transition period.
43+
44+
---
45+
46+
## Content (Deprecated)
247

348
This repository contains the code and documentation for https://docs.splunk.com/Observability
449

550
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).
651

7-
## Contribute to the documentation
52+
53+
### Contribute to the documentation (Deprecated)
854

955
Docs contributions are welcome. See [CONTRIBUTING.md](CONTRIBUTING.md) for the contribution guidelines.
1056

11-
## Requirements
57+
### Requirements (Deprecated)
1258

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

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

1763
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.
1864

19-
### Install the docs on your machine
65+
#### Install the docs on your machine (Deprecated)
2066

2167
Follow these steps to fork this repo and install it on your machine:
2268

2369
1. Clone this repository using `git clone`.
2470
2. Navigate to the cloned repository in your file system.
2571
3. Change the permissions of `start.sh` by entering `chmod +x start.sh` in the terminal.
2672

27-
## License
73+
### License (Deprecated)
2874

2975
This Splunk repository is subject to the Splunk Websites Terms and Conditions of Use ("Terms")
3076
[https://www.splunk.com/en_us/legal/terms/terms-of-use.html](https://www.splunk.com/en_us/legal/terms/terms-of-use.html)

0 commit comments

Comments
 (0)