}){kind=icon}
Create or Edit a Doc
+Create or edit a doc and submit a PR.
Move or Remove a Doc
+Move or remove a doc and set up a redirect.
Style Guide
+Styling and formatting conventions for Sumo Logic Docs.
Glossary
+Definitions of Sumo Logic terms and features you'll encounter in the docs.
Word List
+Preferred spelling, capitalization, and punctuation for Sumo Logic terms.
+
+
+
Docs Templates
+Copy-paste templates for starting a new doc, App Catalog doc, or Cloud-to-Cloud source doc.
Code of Conduct
+Our community standards for contributors.
})
:::warning
- Never do a Find All > Replace All, as this can break unrelated items like image paths. Replace each URL on a one-by-one basis.
+ Never do a Find All > Replace All, as this can break unrelated items like image paths. Replace each URL one at a time.
:::
1. If applicable:
* Remove from its parent index.md hub page.
* Remove from [Product List](/docs/integrations/product-list/).
-## Step 3: Delete the doc file
+## Step 4: Delete the doc file
-Delete the actual .md doc file from the repository (in this example, it'd be `docs/integrations/web-servers/nginx-legacy.md`).
+Delete the actual .md doc file from the repository (in this example, it would be `docs/integrations/web-servers/nginx-legacy.md`).
-## Step 4: Remove doc from navigation
+## Step 5: Remove doc from navigation
Remove the doc from the navigation menu ([sidebars.ts](https://github.com/SumoLogic/sumologic-documentation/blob/main/sidebars.ts) file).
-## Step 5: Publish and test the redirect
+## Step 6: Preview your changes
+
+import Preview from '../reuse/contributing/preview.md';
+
+
+
diff --git a/docs/contributing/templates/partner-app-doc.md b/docs/contributing/templates/partner-app-doc.md
index 7817206cd57..d76910f9aca 100644
--- a/docs/contributing/templates/partner-app-doc.md
+++ b/docs/contributing/templates/partner-app-doc.md
@@ -8,112 +8,14 @@ description: Use this template to create a Sumo Logic Partner app doc (/docs/int
-Use this template to create a [Sumo Logic Partner app](/docs/integrations/partner-ecosystem-apps) doc. Copy and paste this into your new .md file. Refer to the [Style Guide](/docs/contributing/style-guide) if needed.
+:::important
+Most Partner Ecosystem apps are documented on the partner's own website or in the [sumologic-public-partner-apps](https://github.com/SumoLogic/sumologic-public-partner-apps) GitHub repo, not as an individual page on this site. Use this template only if you're creating a new, individually hosted partner app doc here.
+:::
+For [Sumo Logic Partner app](/docs/integrations/partner-ecosystem-apps) docs, follow the [apps template](/docs/contributing/templates/app-template-v2), and append this at the end:
```md
-
----
-id: vendor-name
-title: Vendor Name
-description: Short description.
----
-
-import useBaseUrl from '@docusaurus/useBaseUrl';
-
-`
+
+
+
+Doc (Generic) Template
+Create a general feature, how-to, or concept doc.
+
+
+
+
+Apps Template
+Create an App Catalog integration doc.
+
+
+
+
+Cloud-to-Cloud Source Template
+Create a Cloud-to-Cloud source doc.
+
+
+
+
+Partner App Template
+Create a Sumo Logic Partner app doc.
+}){kind=icon}
`
-
-(Introduction about the app)
-
-\Add the description from the app description above\
-
-## Log types and metrics
-
-The `{AppName}` App uses...
-
-\Enter a list of log types, usually hyperlinked to vendor docs.\
-
-## Sample log and metrics messages
-
-### Log message
-
-```json title="Log message"
-\})
Use descriptive commit messages (and issue or ticket numbers, if applicable) detailing the content updates you are entering for content. One-line messages are fine for small changes, but bigger changes should look like this: +1. [Commit your changes](https://github.com/git-guides/git-commit) to the branch with a meaningful message.
Use descriptive commit messages (and issue or ticket numbers, if applicable) that describe the changes you're making. One-line messages are fine for small changes, but bigger changes should look like this: ```bash $ git commit -m "A brief summary of the commit > @@ -11,17 +11,16 @@ import useBaseUrl from '@docusaurus/useBaseUrl'; 1. Visit [our repo](https://github.com/SumoLogic/sumologic-documentation) after pushing your branch. If you see an option to **Compare & pull request** for your branch, click this.
})
* If you do not see it, [create a new PR](https://github.com/SumoLogic/sumologic-documentation/compare).
1. Select `main` for the base branch. This is the branch all staging and production content builds from.
- 1. Select your branch for the **compare**.
- 1. Click **Create pull request**.
-1. On the Pull Request page, enter the following:
+ 1. Select your branch for the comparison.
+ 1. Click **Create pull request**.})
+1. On the PR page, enter the following:
* Make sure **base** branch is `main` and **compare** branch is the one you pushed.
* Enter a title for the PR.
* If applicable, include a GitHub issue number (or, for internal Sumos, the Jira ticket number).
- * Describe what changed, new pages, updates.
+ * Describe the changes you made.
* Apply a [label](https://github.com/SumoLogic/sumologic-documentation/wiki#github-labels) that best describes your contribution.
1. (Optional). For urgent, high-priority PRs (for example, doc edits tied to a GA release happening within 24 hours):
- 1. Add the GA release date to the title. For example, `AWS Integration release (GA: Jan 1, 2023)`.
- 1. From the labels list, select the `hot🔥` label, signifying it's an extremely urgent PR.
- 1. For internal Sumos only: after completion of all GitHub checks, send your PR link to the `#doc-int` and `#open-source` Slack channels for review.
-1. Click **Create pull request**.
-1. First-time contributors will be prompted in a comment to sign our Contributor License Agreement. We allow individual contributions and contributions made on behalf of companies.})
+ 1. Add the GA release date to the title. For example, `AWS Integration release (GA: Jan 1, 2026)`.
+ 1. From the labels list, select the `hot🔥` label, signifying it's an urgent PR.
+ 1. For internal Sumos only: after completion of all GitHub checks, send your PR link to the **#dochub** Slack channel for review.
+1. First-time contributors will be prompted in a PR comment to sign our Contributor License Agreement. We allow individual contributions and contributions made on behalf of companies.
diff --git a/docs/reuse/contributing/tools.md b/docs/reuse/contributing/tools.md
deleted file mode 100644
index a86cf50e542..00000000000
--- a/docs/reuse/contributing/tools.md
+++ /dev/null
@@ -1,12 +0,0 @@
-
-
diff --git a/docs/reuse/doc-prerequisites.md b/docs/reuse/doc-prerequisites.md
deleted file mode 100644
index 589d3a0a243..00000000000
--- a/docs/reuse/doc-prerequisites.md
+++ /dev/null
@@ -1,3 +0,0 @@
-* You'll need a [GitHub account](https://github.com/signup/free) to contribute to Sumo Logic Docs.
-* We recommend adding [2FA protection](https://devdocs.magento.com/contributor-guide/contributing.html#two-factor) when contributing to Sumo Logic repositories.
-* Help us keep Sumo Logic Docs open and inclusive by reviewing our [Code of Conduct](/docs/contributing/code-of-conduct).
diff --git a/docusaurus.config.js b/docusaurus.config.js
index cbaa18727b2..d572b0216a6 100644
--- a/docusaurus.config.js
+++ b/docusaurus.config.js
@@ -485,6 +485,11 @@ module.exports = {
label: 'Traces, RUM, APM',
icon: 'account_tree',
},
+ {
+ label: 'Contribute to Docs',
+ to: 'docs/contributing',
+ icon: 'edit_note',
+ },
]
},
{
@@ -532,11 +537,6 @@ module.exports = {
to: 'https://github.com/SumoLogic/sumologic-documentation/issues/new/choose',
icon: 'thumbs_up_down',
},
- {
- label: 'Contribute to Docs',
- to: 'docs/contributing',
- icon: 'edit_note',
- },
],
},
{
diff --git a/sidebars.ts b/sidebars.ts
index 71cca5484a2..ca05982e21f 100644
--- a/sidebars.ts
+++ b/sidebars.ts
@@ -60,20 +60,21 @@ module.exports = {
'contributing/style-guide',
'contributing/glossary',
'contributing/word-list',
- 'contributing/code-of-conduct',
// 'contributing/translations',
{
type: 'category',
label: 'Docs Templates',
collapsible: true,
collapsed: true,
+ link: {type: 'doc', id: 'contributing/templates/index'},
items: [
'contributing/templates/app-template-v2',
'contributing/templates/c2c-source',
'contributing/templates/generic-doc',
'contributing/templates/partner-app-doc',
]
- }
+ },
+ 'contributing/code-of-conduct',
],
},
],