|
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) |
2 | 47 |
|
3 | 48 | This repository contains the code and documentation for https://docs.splunk.com/Observability |
4 | 49 |
|
5 | 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). |
6 | 51 |
|
7 | | -## Contribute to the documentation |
| 52 | + |
| 53 | +### Contribute to the documentation (Deprecated) |
8 | 54 |
|
9 | 55 | Docs contributions are welcome. See [CONTRIBUTING.md](CONTRIBUTING.md) for the contribution guidelines. |
10 | 56 |
|
11 | | -## Requirements |
| 57 | +### Requirements (Deprecated) |
12 | 58 |
|
13 | 59 | The documentation is built from [reStructuredText](https://docutils.sourceforge.io/rst.html) files using [Sphinx](https://www.sphinx-doc.org/en/master/). |
14 | 60 |
|
15 | 61 | To contribute to the documentation you need a GitHub account. See [CONTRIBUTING.md](CONTRIBUTING.md) for our contribution guidelines. |
16 | 62 |
|
17 | 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. |
18 | 64 |
|
19 | | -### Install the docs on your machine |
| 65 | +#### Install the docs on your machine (Deprecated) |
20 | 66 |
|
21 | 67 | Follow these steps to fork this repo and install it on your machine: |
22 | 68 |
|
23 | 69 | 1. Clone this repository using `git clone`. |
24 | 70 | 2. Navigate to the cloned repository in your file system. |
25 | 71 | 3. Change the permissions of `start.sh` by entering `chmod +x start.sh` in the terminal. |
26 | 72 |
|
27 | | -## License |
| 73 | +### License (Deprecated) |
28 | 74 |
|
29 | 75 | This Splunk repository is subject to the Splunk Websites Terms and Conditions of Use ("Terms") |
30 | 76 | [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