Added views docs #4522

JV0812 · 2024-09-11T06:45:08Z

Purpose of this pull request

This pull request is to add the Views docs.

Select the type of change

Minor Changes - Typos, formatting, slight revisions
Update Content - Revisions, updating sections
New Content - New features, sections, pages, tutorials
Site and Tools - .clabot, version updates, maintenance, dependencies, new packages for the site (Docusaurus, Gatsby, React, etc.)

Ticket (if applicable)

Documentation for new Views page instead of existing Scheduled Page

docs/get-started/onboarding-checklists.md

cid-redirects.json

sidebars.ts

docs/contributing/glossary.md

docs/manage/manage-subscription/fedramp-capabilities.md

Co-authored-by: Kim (Sumo Logic) <[email protected]>

…ologic-documentation into views-doc-creation

docs/manage/views/scheduled-views/pause-disable-view.md

docs/alerts/scheduled-searches/save-to-index.md

docs/api/scheduled-views.md

jpipkin1 · 2024-10-14T19:52:05Z

docs/manage/data-forwarding/amazon-s3-bucket.md

+You can forward log data from a [Partition](/docs/manage/partitions) or [Views](/docs/manage/views) to an S3 bucket. Only new data is forwarded from a Partition once it is set to forward data. 
+
+After data forwarding is configured, you should start to see file objects posted within your configured bucket. If your Scheduled View conducts aggregation, which is a best practice, your aggregate fields are automatically appended to the forwarded objects.
+


Suggested change

You can forward log data from a [Partition](/docs/manage/partitions) or [Views](/docs/manage/views) to an S3 bucket. Only new data is forwarded from a Partition once it is set to forward data.

After data forwarding is configured, you should start to see file objects posted within your configured bucket. If your Scheduled View conducts aggregation, which is a best practice, your aggregate fields are automatically appended to the forwarded objects.

Remove these paragraphs because they repeat text from the beginning of the article.

jpipkin1 · 2024-10-14T19:55:30Z

docs/manage/data-forwarding/index.md

@@ -8,7 +8,7 @@ import useBaseUrl from '@docusaurus/useBaseUrl';

 <img src={useBaseUrl('img/icons/operations/send-data.png')} alt="Document with a forward symbol icon" width="50"/>

-Data Forwarding allows you to forward log data to an external server or supported storage service. You can forward log data to an AWS S3 bucket through [Partitions](/docs/manage/partitions) or [Scheduled Views](/docs/manage/scheduled-views). See [Forwarding Data from Sumo Logic to S3](/docs/manage/data-forwarding/amazon-s3-bucket/) for details.
+Data Forwarding allows you to forward log data to an external server or supported storage service. You can forward log data to an AWS S3 bucket through [Partitions](/docs/manage/partitions) or [Views](/docs/manage/views). See [Forwarding Data from Sumo Logic to S3](amazon-s3-bucket.md) for details.


Suggested change

Data Forwarding allows you to forward log data to an external server or supported storage service. You can forward log data to an AWS S3 bucket through [Partitions](/docs/manage/partitions) or [Views](/docs/manage/views). See [Forwarding Data from Sumo Logic to S3](amazon-s3-bucket.md) for details.

Data Forwarding allows you to forward log data to an external server or supported storage service. You can forward log data to an AWS S3 bucket through [Partitions](/docs/manage/partitions) or [Scheduled Views](/docs/manage/views/scheduled-views). See [Forwarding Data from Sumo Logic to S3](amazon-s3-bucket.md) for details.

jpipkin1 · 2024-10-14T20:05:45Z

docs/manage/security/audit-indexes/audit-event-index.md

@@ -61,7 +61,7 @@ _index=sumologic_audit_events _sourceCategory=accessKeys
 | [Password Policy](/docs/manage/security/set-password-policy) | `passwordPolicy` |
 | [Roles](/docs/manage/users-roles/roles/create-manage-roles) | `roles` |
 | [SAML](/docs/manage/security/saml) | `saml` |
-| [Scheduled Views](/docs/manage/scheduled-views) | `scheduledView` |
+| [Scheduled Views](/docs/manage/views) | `scheduledView` |


docs/manage/users-roles/roles/role-capabilities.md

docs/manage/views/index.md

jpipkin1 · 2024-10-14T20:13:54Z

docs/manage/views/scheduled-searches/index.md

+```
+## Should I create a Scheduled View or use Save to Index?
+
+In most cases, if you can use a [Scheduled View](/docs/manage/views) for your use case, this may be a better option, as Scheduled Views include many built in safeguards, as well as management features. If your search query needs to use operators that are restricted for Scheduled Views, saving your Scheduled Search results to an Index allows you to do this.


Suggested change

In most cases, if you can use a [Scheduled View](/docs/manage/views) for your use case, this may be a better option, as Scheduled Views include many built in safeguards, as well as management features. If your search query needs to use operators that are restricted for Scheduled Views, saving your Scheduled Search results to an Index allows you to do this.

In most cases, if you can use a [Scheduled View](/docs/manage/views/scheduled-views) for your use case, this may be a better option, as Scheduled Views include many built in safeguards, as well as management features. If your search query needs to use operators that are restricted for Scheduled Views, saving your Scheduled Search results to an Index allows you to do this.

jpipkin1 · 2024-10-14T20:14:46Z

docs/manage/views/scheduled-searches/index.md

+<div className="box-wrapper">
+<div className="box smallbox card">
+  <div className="container">
+  <a href="/docs/manage/views/scheduled-searches/add-schedule-search"><img src={useBaseUrl('img/icons/general/calendar.png')} alt="icon" width="40"/><h4>Create a Scheduled Search</h4></a>


Suggested change

<a href="/docs/manage/views/scheduled-searches/add-schedule-search"><img src={useBaseUrl('img/icons/general/calendar.png')} alt="icon" width="40"/><h4>Create a Scheduled Search</h4></a>

<a href="/docs/manage/views/scheduled-searches/add-schedule-search"><img src={useBaseUrl('img/icons/general/calendar.png')} alt="icon" width="40"/><h4>Add a Scheduled Search</h4></a>

jpipkin1 · 2024-10-14T20:21:31Z

docs/manage/views/view-list.md

+The page has information about viewing information about the views/indexes configured for your organization.
+
+:::note
+You must have a role that grants you the View Scheduled Views [role capability](/docs/manage/views/view-list) in order to view information about scheduled views.


Suggested change

You must have a role that grants you the View Scheduled Views [role capability](/docs/manage/views/view-list) in order to view information about scheduled views.

You must have a role that grants you the View Scheduled Views [role capability](/docs/manage/users-roles/roles/role-capabilities/) in order to view information about scheduled views.

docs/reuse/fer-limitations.md

i18n/ja/alerts/alerts/scheduled-searches/save-to-index.md

jpipkin1

Wow, that's a lot of great stuff, @JV0812! I have only a few minor suggestions, mostly having to do with linking.

Co-authored-by: John Pipkin (Sumo Logic) <[email protected]>

jpipkin1 · 2024-12-04T18:28:00Z

@JV0812, I noticed that you haven't addressed by suggestions yet. Let me know if you need another review.

Co-authored-by: John Pipkin (Sumo Logic) <[email protected]>

JV0812 · 2024-12-11T04:07:19Z

@jpipkin1 Thanks for your review. But the feature development is still under process and not sure with the upcoming changes. So I will work on your feedback when I incorporate the future feature updates.

jpipkin1 · 2024-12-11T15:09:39Z

@JV0812, I converted the PR to a draft since work on it is still in progress.

Added views docs

5b3a10b

JV0812 requested review from kimsauce, jpipkin1 and mafsumo as code owners September 11, 2024 06:45

cla-bot bot added the cla-signed Contributor approved, listed in .clabot file label Sep 11, 2024

JV0812 marked this pull request as draft September 11, 2024 06:45

JV0812 self-assigned this Sep 11, 2024

JV0812 added the do-not-merge Pull requests that should not be merged label Sep 11, 2024

JV0812 added 3 commits September 11, 2024 12:21

minor fix

7a63cf6

url updated

d6a8b6f

url fix

fd96da3

kimsauce reviewed Sep 12, 2024

View reviewed changes

docs/get-started/onboarding-checklists.md Outdated Show resolved Hide resolved

kimsauce reviewed Sep 12, 2024

View reviewed changes

cid-redirects.json Outdated Show resolved Hide resolved

kimsauce reviewed Sep 12, 2024

View reviewed changes

cid-redirects.json Outdated Show resolved Hide resolved

kimsauce reviewed Sep 12, 2024

View reviewed changes

sidebars.ts Outdated Show resolved Hide resolved

kimsauce and others added 4 commits September 17, 2024 10:43

Merge branch 'main' into views-doc-creation

3b95bc0

Merge branch 'main' into views-doc-creation

f545a78

Update cid-redirects.json

c0ef6ae

Update cid-redirects.json

735c8b9

kimsauce self-requested a review September 17, 2024 17:50

kimsauce reviewed Sep 17, 2024

View reviewed changes

docs/contributing/glossary.md Outdated Show resolved Hide resolved

kimsauce reviewed Sep 17, 2024

View reviewed changes

docs/manage/manage-subscription/fedramp-capabilities.md Outdated Show resolved Hide resolved

kimsauce and others added 8 commits September 17, 2024 11:10

scheduled view --> view edits

9641644

fix links

e5cf1ee

Update docs/manage/manage-subscription/fedramp-capabilities.md

1a5e068

Update docs/get-started/onboarding-checklists.md

f342cdd

Co-authored-by: Kim (Sumo Logic) <[email protected]>

path fixes

c2c428e

Merge branch 'views-doc-creation' of https://github.com/SumoLogic/sum…

94c53f6

…ologic-documentation into views-doc-creation

minor fix

72fcb54

updated the docs and screenshots

8cc9108

JV0812 added 4 commits October 8, 2024 17:49

Update cid-redirects.json

8f1e545

minor fix

9e5f131

minor fix

2eda38c

Merge branch 'main' into views-doc-creation

8f8f5c3