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

Update readme archive repo #1751

Merged
merged 6 commits into from
Jul 1, 2025
Merged

Update readme archive repo #1751

Changes from all commits
Commits
Show all changes
6 commits
Select commit Hold shift + click to select a range
4f2d61e
Updating the README to include a note and information about the archi…
jcatera-splunk Jun 14, 2025
ddd0224
Update README.md
jcatera-splunk Jun 27, 2025
eafc0b3
Update README.md
jcatera-splunk Jun 27, 2025
67cdd56
Update README.md
jcatera-splunk Jun 27, 2025
fc65838
Update README.md
jcatera-splunk Jun 27, 2025
b433205
Update README.md
jcatera-splunk Jun 27, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
92 changes: 74 additions & 18 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,33 +1,89 @@
# Splunk Observability Cloud Documentation
# DEPRECATED: Splunk Observability Cloud Documentation

This repository contains the code and documentation for https://docs.splunk.com/Observability
[![status: archive](https://github.com/GIScience/badges/raw/master/status/archive.svg)](https://github.com/GIScience/badges#archive)
[![ARCHIVED/NO LONGER MAINTAINED](http://unmaintained.tech/badge.svg)](http://unmaintained.tech/)

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).
> [!IMPORTANT]
> This repository, public-o11y-docs, will soon be archived and transitioned to a read-only
> state as part of our migration to a new authoring and publishing platform. We would
> like to take this opportunity to thank all contributors, collaborators, and organization
> members for their valuable contributions to this project. Your efforts have played
> a critical role in its development and success. We encourage you to explore our new documentation available at https://help.splunk.com/en/splunk-observability-cloud.

## Contribute to the documentation
## Key Dates and Timeline

Docs contributions are welcome. See [CONTRIBUTING.md](CONTRIBUTING.md) for the contribution guidelines.
### July 1st, 2025:

## Requirements
* The repository will enter maintenance mode, and no new collaborators or contributors will be added.
* Only individuals with prior contributions will retain the ability to participate.

The documentation is built from [reStructuredText](https://docutils.sourceforge.io/rst.html) files using [Sphinx](https://www.sphinx-doc.org/en/master/).
### July 1st – July 31st, 2025:

To contribute to the documentation you need a GitHub account. See [CONTRIBUTING.md](CONTRIBUTING.md) for our contribution guidelines.
* Existing contributors may continue to create pull requests (PRs).
* Contributors without prior involvement in the repository will no longer be able to participate.

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.
### August 1st – August 30th, 2025:

### Install the docs on your machine
Contribution permissions will be limited to Collaborators and Organization members only.

Follow these steps to fork this repo and install it on your machine:
### August 30th, 2025:

1. Clone this repository using `git clone`.
2. Navigate to the cloned repository in your file system.
3. Change the permissions of `start.sh` by entering `chmod +x start.sh` in the terminal.
The repository will be officially archived and transitioned to a read-only state.

## License
## What Happens After Archiving

This Splunk repository is subject to the Splunk Websites Terms and Conditions of Use ("Terms")
Once the repository is archived:

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

## Providing feedback in the future

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 get in touch with us at [email protected].

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

---

## Content (Deprecated)

> [!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.

~This repository contains the code and documentation for our old doc site at [https://docs.splunk.com/Observability](https://docs.splunk.com/observability/en/).~

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


### Contribute to the documentation (Deprecated)

> [!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).

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


### Requirements (Deprecated)

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

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

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

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

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

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

### License (Deprecated)

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

You can contribute new documentation and edits to the existing documentation.
~You can contribute new documentation and edits to the existing documentation.~