|
1 | 1 | # Splunk Observability Cloud Documentation - Archived |
2 | 2 |
|
| 3 | +[](http://unmaintained.tech/) |
| 4 | + |
3 | 5 | > [!IMPORTANT] |
4 | 6 | > This repository, public-o11y-docs, will soon be archived and transitioned to a read-only |
5 | 7 | > 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 |
27 | 29 |
|
28 | 30 | The repository will be officially archived and transitioned to a read-only state. |
29 | 31 |
|
30 | | -## What Happens After Archival |
| 32 | +## What Happens After Archiving |
31 | 33 |
|
32 | 34 | Once the repository is archived: |
33 | 35 |
|
34 | 36 | * It will remain accessible in a read-only state for reference purposes. |
35 | 37 | * No further pull requests (PRs), issues, or contributions will be accepted. |
36 | 38 | * The repository’s history will remain available for cloning and viewing but will no longer allow modifications. |
37 | 39 |
|
38 | | -## Moving Forward |
| 40 | +## Providing feedback in the future |
39 | 41 |
|
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]. |
41 | 43 |
|
42 | 44 | We sincerely appreciate your understanding and cooperation during this transition period. |
43 | 45 |
|
44 | 46 | --- |
45 | 47 |
|
46 | 48 | ## Content (Deprecated) |
47 | 49 |
|
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/). |
49 | 53 |
|
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).~ |
51 | 55 |
|
52 | 56 |
|
53 | 57 | ### Contribute to the documentation (Deprecated) |
54 | 58 |
|
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 | + |
56 | 63 |
|
57 | 64 | ### Requirements (Deprecated) |
58 | 65 |
|
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/). |
60 | 67 |
|
61 | 68 | To contribute to the documentation you need a GitHub account. See [CONTRIBUTING.md](CONTRIBUTING.md) for our contribution guidelines. |
62 | 69 |
|
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.~ |
64 | 71 |
|
65 | 72 | #### Install the docs on your machine (Deprecated) |
66 | 73 |
|
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: |
68 | 75 |
|
69 | 76 | 1. Clone this repository using `git clone`. |
70 | 77 | 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.~ |
72 | 79 |
|
73 | 80 | ### License (Deprecated) |
74 | 81 |
|
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") |
76 | 83 | [https://www.splunk.com/en_us/legal/terms/terms-of-use.html](https://www.splunk.com/en_us/legal/terms/terms-of-use.html) |
77 | 84 | and the [LICENSE](LICENSE) specific to this repository. |
78 | 85 |
|
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