Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Update README.md #84

Open
wants to merge 1 commit into
base: develop
Choose a base branch
from
Open

Update README.md #84

Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
122 changes: 71 additions & 51 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -55,64 +55,84 @@ To host this documentation on your local machine, follow these steps.

### Markdown structure

Here's an a detailed overview of the entire markdown file structure of the documentation.
Expand the header below to view a detailed overview of the documentation's entire markdown file structure.

<details>
<summary>SigLens Docs Directory Structure</summary>

```
|-- /siglens-docs
|-- README.md
|-- /docs
|-- alerts.md
|-- /benchmarks
| |-- /docs
| |-- alerts.md
| |-- /benchmarks
| |-- nyc-taxi-benchmark-runbook.md
|-- cluster-health.md
|-- community.md
|-- contribution-guidelines.md
|-- dashboards.md
|-- /installation
| | |-- /benchmarks
| | |-- nyc-taxi-benchmark-runbook.md
| |-- cluster-health.md
| |-- community.md
| |-- contribution-guidelines.md
| |-- dashboards.md
| |-- /installation
| |-- docker.md
| |-- git.md
| |-- helm.md
|-- /instrument-traces
| | |-- /installation
| | |-- docker.md
| | |-- git.md
| | |-- helm.md
| |-- /instrument-traces
| |-- dotnet-app.md
| |-- go-app.md
| |-- java-app.md
| |-- js-app.md
| |-- python-app.md
|-- introduction.md
|-- key-concepts.md
|-- /log-ingestion
| |-- /beats
| | |-- /beats
| | |-- filebeat-elasticsearch.md
| | |-- metricbeat-elasticsearch.md
| | |-- /instrument-traces
| | |-- dotnet-app.md
| | |-- go-app.md
| | |-- java-app.md
| | |-- js-app.md
| | |-- python-app.md
| |-- introduction.md
| |-- key-concepts.md
| |-- /log-ingestion
| |-- elastic-search.md
| |-- /fluentd
| | |-- /fluentd
| | |-- fluentd-elasticsearch.md
| | |-- fluentd-splunk.md
| |-- fluentd-fluentbit.md
| |-- /logstash
| | |-- /logstash
| | |-- logstash-elasticsearch.md
| | |-- logstash-splunk.md
| |-- loki.md
| |-- open-telemetry.md
| |-- splunk-hec.md
| |-- /vector
| | |-- /vector
| | |-- vector-elasticsearch.md
| | |-- vector-install.md
| | |-- vector-splunk-hec-logs.md
| | |-- vector-splunk-hec-metrics.md
| |-- vector.md
|-- log-query-builder.md
|-- minion-searches.md
|-- retention.md
|-- saved-searches.md
|-- searching-logs.md
| | |-- /log-ingestion
| | |-- filebeat.md
| | |-- fluentd.md
| | |-- logstash.md
| | |-- open-telemetry.md
| | |-- promtail.md
| | |-- vector.md
| |-- log-query-builder.md
| |-- /metric-ingestion
| | |-- /metric-ingestion
| | |-- metricbeat.md
| | |-- open-telemetry.md
| | |-- vector-metrics.md
| |-- /migration
| | |-- /awscloudwatch
| | | |-- /awscloudwatch
| | | |-- aws-lambda.md
| | | |-- fluentd.md
| | |-- /datadog
| | | |-- /datadog
| | | |-- vector.md
| | |-- /elasticsearch
| | | |-- /elasticsearch
| | | |-- fluentd.md
| | | |-- logstash.md
| | | |-- vector.md
| | |-- /gcloud
| | | |-- /gcloud
| | | |-- vector.md
| | |-- /loki
| | | |-- /loki
| | | |-- promtail.md
| | |-- /splunk
| | | |-- /splunk
| | | |-- fluentd.md
| | | |-- logstash.md
| | | |-- vector.md
| |-- minion-searches.md
| |-- retention.md
| |-- saved-searches.md
| |-- searching-logs.md
```

</details>

> [!NOTE]
> When creating new content file or adjusting docs hierarchy, please consult the SigLens team by opening a Github Issue in this repository.

Expand Down Expand Up @@ -175,4 +195,4 @@ Thank you to all the contributors who have helped grow SigLens. Your efforts are
</a> -->
<a href="https://www.linkedin.com/company/sigscalr-io/?miniCompanyUrn=urn%3Ali%3Afs_miniCompany%3A77978282" target="_blank">
<img src=https://img.shields.io/badge/linkedin-%231E77B5.svg?&style=for-the-badge&logo=linkedin&logoColor=white alt=SigLens_linkedin style="margin-bottom: 5px;" />
</a>
</a>