Skip to content

Commit

Permalink
chore: documentation structure #52
Browse files Browse the repository at this point in the history
  • Loading branch information
RejinaKP committed Oct 7, 2024
1 parent c5af041 commit 1083ef3
Show file tree
Hide file tree
Showing 163 changed files with 118 additions and 118 deletions.
File renamed without changes
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes
File renamed without changes
File renamed without changes
File renamed without changes
File renamed without changes
File renamed without changes
File renamed without changes
File renamed without changes
File renamed without changes
File renamed without changes
File renamed without changes
File renamed without changes
File renamed without changes
File renamed without changes
File renamed without changes
File renamed without changes
File renamed without changes
File renamed without changes
File renamed without changes
File renamed without changes
File renamed without changes
File renamed without changes
File renamed without changes
File renamed without changes
File renamed without changes
File renamed without changes
File renamed without changes
File renamed without changes
File renamed without changes
File renamed without changes
File renamed without changes
File renamed without changes
4 changes: 2 additions & 2 deletions src/content/docs/docs.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -13,8 +13,8 @@ hero:
tagline: ""
image:
alt: A Survelir's Logo
dark: ../../assets/surveilr-logo-with-subtitle.png
light: ../../assets/surveilr-logo-with-subtitle.png
dark: ../../assets/images/content/docs/surveilr-logo-with-subtitle.png
light: ../../assets/images/content/docs/surveilr-logo-with-subtitle.png
actions:
- text: Resource Surveillance
icon: right-arrow
Expand Down
12 changes: 6 additions & 6 deletions src/content/docs/docs/core/cli/ingest-commands/imap.md
Original file line number Diff line number Diff line change
Expand Up @@ -15,19 +15,19 @@ To use the `surveilr ingest imap` command with Microsoft 365 authentication meth
1. **Sign in to the** [Azure Portal](https://portal.azure.com/#home).

2. Click **Applications** to create a new app.
![New registration](../../../../../../assets/images/applications.avif)
![New registration](../../../../../../assets/images/content/docs/core/cli/ingest-commands/applications.avif)

3. In the left navigation panel, select **App registrations**
![App registrations](../../../../../../assets/images/app-registrations.avif)
![App registrations](../../../../../../assets/images/content/docs/core/cli/ingest-commands/app-registrations.avif)

1. Provide a name for your app, such as "Surveilr App"
![Surveilr App](../../../../../../assets/images/surveilr-app.avif)
![Surveilr App](../../../../../../assets/images/content/docs/core/cli/ingest-commands/surveilr-app.avif)

1. Choose the appropriate **Supported account types** for your app by clicking on Authentication and selecting "Accounts in any organizational directory."
![Authentication](../../../../../../assets/images/authentication.avif)
![Authentication](../../../../../../assets/images/content/docs/core/cli/ingest-commands/authentication.avif)

1. Set the **Redirect URI** as application's redirect URL (e.g., `https://your-redirect-uri.com/redirect`).
![redirect URL](../../../../../../assets/images/redirect-url.avif)
![redirect URL](../../../../../../assets/images/content/docs/core/cli/ingest-commands/redirect-url.avif)


**Note**: Redirect URL will be a proxy pass (https) connection to the `surveilr imap ingest` service.
Expand All @@ -40,7 +40,7 @@ To use the `surveilr ingest imap` command with Microsoft 365 authentication meth
9. Copy the **Application (client) ID** and the newly created **client secret** as you will need them for authentication.

10. Set the necessary permissions for the application.
![API_permission](../../../../../../assets/images/api-permission.avif)
![API_permission](../../../../../../assets/images/content/docs/core/cli/ingest-commands/api-permission.avif)



Expand Down
4 changes: 2 additions & 2 deletions src/content/docs/docs/docs.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -13,8 +13,8 @@ hero:
tagline: ""
image:
alt: A Resource Surveliance Logo
dark: ../../../assets/_image.png
light: ../../../assets/_image.png
dark: ../../../assets/images/content/docs/_image.png
light: ../../../assets/images/content/docs/_image.png
actions:
- text: Resource Surveillance
icon: right-arrow
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -64,4 +64,4 @@ CREATE TABLE "assurance_schema" (

## Relations

![er](../../../../../assets/assurance_schema.svg)
![er](../../../../../assets/images/content/docs/standard-library/notebooks-schema/assurance_schema.svg)
Original file line number Diff line number Diff line change
Expand Up @@ -77,4 +77,4 @@ CREATE TABLE "code_notebook_cell" (

## Relations

![er](../../../../../assets/code_notebook_cell.svg)
![er](../../../../../assets/images/content/docs/standard-library/notebooks-schema/code_notebook_cell.svg)
Original file line number Diff line number Diff line change
Expand Up @@ -71,4 +71,4 @@ CREATE TABLE "code_notebook_kernel" (

## Relations

![er](../../../../../assets/code_notebook_kernel.svg)
![er](../../../../../assets/images/content/docs/standard-library/notebooks-schema/code_notebook_kernel.svg)
Original file line number Diff line number Diff line change
Expand Up @@ -75,4 +75,4 @@ CREATE TABLE "code_notebook_state" (

## Relations

![er](../../../../../assets/code_notebook_state.svg)
![er](../../../../../assets/images/content/docs/standard-library/notebooks-schema/code_notebook_state.svg)
Original file line number Diff line number Diff line change
Expand Up @@ -15,4 +15,4 @@ description: Resource Surveillance Notebooks Schema

## Relations

![er](../../../../../assets/notebooks_schema.svg)
![er](../../../../../assets/images/content/docs/standard-library/notebooks-schema/notebooks_schema.svg)
Original file line number Diff line number Diff line change
Expand Up @@ -78,4 +78,4 @@ CREATE TABLE "behavior" (

## Relations

![er](../../../../../assets/behavior.svg)
![er](../../../../../assets/images/content/docs/standard-library/rssd-schema/behavior.svg)
Original file line number Diff line number Diff line change
Expand Up @@ -73,4 +73,4 @@ CREATE TABLE "device" (

## Relations

![er](../../../../../assets/device.svg)
![er](../../../../../assets/images/content/docs/standard-library/rssd-schema/device.svg)
Original file line number Diff line number Diff line change
Expand Up @@ -67,4 +67,4 @@ CREATE TABLE "device_party_relationship" (

## Relations

![er](../../../../../assets/device_party_relationship.svg)
![er](../../../../../assets/images/content/docs/standard-library/rssd-schema/device_party_relationship.svg)
Original file line number Diff line number Diff line change
Expand Up @@ -40,4 +40,4 @@ CREATE TABLE "gender_type" (

## Relations

![er](../../../../../assets/gender_type.svg)
![er](../../../../../assets/images/content/docs/standard-library/rssd-schema/gender_type.svg)
Original file line number Diff line number Diff line change
Expand Up @@ -61,4 +61,4 @@ CREATE TABLE "orchestration_nature" (

## Relations

![er](../../../../../assets/orchestration_nature.svg)
![er](../../../../../assets/images/content/docs/standard-library/rssd-schema/orchestration_nature.svg)
Original file line number Diff line number Diff line change
Expand Up @@ -64,4 +64,4 @@ CREATE TABLE "orchestration_session" (

## Relations

![er](../../../../../assets/orchestration_session.svg)
![er](../../../../../assets/images/content/docs/standard-library/rssd-schema/orchestration_session.svg)
Original file line number Diff line number Diff line change
Expand Up @@ -50,4 +50,4 @@ CREATE TABLE "orchestration_session_entry" (

## Relations

![er](../../../../../assets/orchestration_session_entry.svg)
![er](../../../../../assets/images/content/docs/standard-library/rssd-schema/orchestration_session_entry.svg)
Original file line number Diff line number Diff line change
Expand Up @@ -74,4 +74,4 @@ CREATE TABLE "orchestration_session_exec" (

## Relations

![er](../../../../../assets/orchestration_session_exec.svg)
![er](../../../../../assets/images/content/docs/standard-library/rssd-schema/orchestration_session_exec.svg)
Original file line number Diff line number Diff line change
Expand Up @@ -62,4 +62,4 @@ CREATE TABLE "orchestration_session_issue" (

## Relations

![er](../../../../../assets/orchestration_session_issue.svg)
![er](../../../../../assets/images/content/docs/standard-library/rssd-schema/orchestration_session_issue.svg)
Original file line number Diff line number Diff line change
Expand Up @@ -50,4 +50,4 @@ CREATE TABLE "orchestration_session_issue_relation" (

## Relations

![er](../../../../../assets/orchestration_session_issue_relation.svg)
![er](../../../../../assets/images/content/docs/standard-library/rssd-schema/orchestration_session_issue_relation.svg)
Original file line number Diff line number Diff line change
Expand Up @@ -52,4 +52,4 @@ CREATE TABLE "orchestration_session_log" (

## Relations

![er](../../../../../assets/orchestration_session_log.svg)
![er](../../../../../assets/images/content/docs/standard-library/rssd-schema/orchestration_session_log.svg)
Original file line number Diff line number Diff line change
Expand Up @@ -66,4 +66,4 @@ CREATE TABLE "orchestration_session_state" (

## Relations

![er](../../../../../assets/orchestration_session_state.svg)
![er](../../../../../assets/images/content/docs/standard-library/rssd-schema/orchestration_session_state.svg)
Original file line number Diff line number Diff line change
Expand Up @@ -71,4 +71,4 @@ CREATE TABLE "organization" (

## Relations

![er](../../../../../assets/organization.svg)
![er](../../../../../assets/images/content/docs/standard-library/rssd-schema/organization.svg)
Original file line number Diff line number Diff line change
Expand Up @@ -72,4 +72,4 @@ CREATE TABLE "organization_role" (

## Relations

![er](../../../../../assets/organization_role.svg)
![er](../../../../../assets/images/content/docs/standard-library/rssd-schema/organization_role.svg)
Original file line number Diff line number Diff line change
Expand Up @@ -40,4 +40,4 @@ CREATE TABLE "organization_role_type" (

## Relations

![er](../../../../../assets/organization_role_type.svg)
![er](../../../../../assets/images/content/docs/standard-library/rssd-schema/organization_role_type.svg)
Original file line number Diff line number Diff line change
Expand Up @@ -62,4 +62,4 @@ CREATE TABLE "party" (

## Relations

![er](../../../../../assets/party.svg)
![er](../../../../../assets/images/content/docs/standard-library/rssd-schema/party.svg)
Original file line number Diff line number Diff line change
Expand Up @@ -72,4 +72,4 @@ CREATE TABLE "party_relation" (

## Relations

![er](../../../../../assets/party_relation.svg)
![er](../../../../../assets/images/content/docs/standard-library/rssd-schema/party_relation.svg)
Original file line number Diff line number Diff line change
Expand Up @@ -40,4 +40,4 @@ CREATE TABLE "party_relation_type" (

## Relations

![er](../../../../../assets/party_relation_type.svg)
![er](../../../../../assets/images/content/docs/standard-library/rssd-schema/party_relation_type.svg)
Original file line number Diff line number Diff line change
Expand Up @@ -40,4 +40,4 @@ CREATE TABLE "party_type" (

## Relations

![er](../../../../../assets/party_type.svg)
![er](../../../../../assets/images/content/docs/standard-library/rssd-schema/party_type.svg)
Original file line number Diff line number Diff line change
Expand Up @@ -73,4 +73,4 @@ CREATE TABLE "person" (

## Relations

![er](../../../../../assets/person.svg)
![er](../../../../../assets/images/content/docs/standard-library/rssd-schema/person.svg)
Original file line number Diff line number Diff line change
Expand Up @@ -54,4 +54,4 @@ description: Documentation for the resource surveillance CLI tool.

## Relations

![er](../../../../../assets/schema.svg)
![er](../../../../../assets/images/content/docs/standard-library/rssd-schema/schema.svg)
Original file line number Diff line number Diff line change
Expand Up @@ -102,4 +102,4 @@ CREATE TABLE "uniform_resource" (

## Relations

![er](../../../../../assets/uniform_resource.svg)
![er](../../../../../assets/images/content/docs/standard-library/rssd-schema/uniform_resource.svg)
Original file line number Diff line number Diff line change
Expand Up @@ -73,4 +73,4 @@ CREATE TABLE "uniform_resource_transform" (

## Relations

![er](../../../../../assets/uniform_resource_transform.svg)
![er](../../../../../assets/images/content/docs/standard-library/rssd-schema/uniform_resource_transform.svg)
Original file line number Diff line number Diff line change
Expand Up @@ -72,4 +72,4 @@ CREATE TABLE "ur_ingest_resource_path_match_rule" (

## Relations

![er](../../../../../assets/ur_ingest_resource_path_match_rule.svg)
![er](../../../../../assets/images/content/docs/standard-library/rssd-schema/ur_ingest_resource_path_match_rule.svg)
Original file line number Diff line number Diff line change
Expand Up @@ -69,4 +69,4 @@ CREATE TABLE "ur_ingest_resource_path_rewrite_rule" (

## Relations

![er](../../../../../assets/ur_ingest_resource_path_rewrite_rule.svg)
![er](../../../../../assets/images/content/docs/standard-library/rssd-schema/ur_ingest_resource_path_rewrite_rule.svg)
Original file line number Diff line number Diff line change
Expand Up @@ -84,4 +84,4 @@ CREATE TABLE "ur_ingest_session" (

## Relations

![er](../../../../../assets/ur_ingest_session.svg)
![er](../../../../../assets/images/content/docs/standard-library/rssd-schema/ur_ingest_session.svg)
Original file line number Diff line number Diff line change
Expand Up @@ -75,4 +75,4 @@ CREATE TABLE "ur_ingest_session_attachment" (

## Relations

![er](../../../../../assets/ur_ingest_session_attachment.svg)
![er](../../../../../assets/images/content/docs/standard-library/rssd-schema/ur_ingest_session_attachment.svg)
Original file line number Diff line number Diff line change
Expand Up @@ -69,4 +69,4 @@ CREATE TABLE "ur_ingest_session_fs_path" (

## Relations

![er](../../../../../assets/ur_ingest_session_fs_path.svg)
![er](../../../../../assets/images/content/docs/standard-library/rssd-schema/ur_ingest_session_fs_path.svg)
Original file line number Diff line number Diff line change
Expand Up @@ -95,4 +95,4 @@ CREATE TABLE "ur_ingest_session_fs_path_entry" (

## Relations

![er](../../../../../assets/ur_ingest_session_fs_path_entry.svg)
![er](../../../../../assets/images/content/docs/standard-library/rssd-schema/ur_ingest_session_fs_path_entry.svg)
Original file line number Diff line number Diff line change
Expand Up @@ -71,4 +71,4 @@ CREATE TABLE "ur_ingest_session_imap_account" (

## Relations

![er](../../../../../assets/ur_ingest_session_imap_account.svg)
![er](../../../../../assets/images/content/docs/standard-library/rssd-schema/ur_ingest_session_imap_account.svg)
Original file line number Diff line number Diff line change
Expand Up @@ -71,4 +71,4 @@ CREATE TABLE "ur_ingest_session_imap_acct_folder" (

## Relations

![er](../../../../../assets/ur_ingest_session_imap_acct_folder.svg)
![er](../../../../../assets/images/content/docs/standard-library/rssd-schema/ur_ingest_session_imap_acct_folder.svg)
Original file line number Diff line number Diff line change
Expand Up @@ -96,4 +96,4 @@ CREATE TABLE "ur_ingest_session_imap_acct_folder_message" (

## Relations

![er](../../../../../assets/ur_ingest_session_imap_acct_folder_message.svg)
![er](../../../../../assets/images/content/docs/standard-library/rssd-schema/ur_ingest_session_imap_acct_folder_message.svg)
Original file line number Diff line number Diff line change
Expand Up @@ -69,4 +69,4 @@ CREATE TABLE "ur_ingest_session_plm_account" (

## Relations

![er](../../../../../assets/ur_ingest_session_plm_account.svg)
![er](../../../../../assets/images/content/docs/standard-library/rssd-schema/ur_ingest_session_plm_account.svg)
Original file line number Diff line number Diff line change
Expand Up @@ -64,4 +64,4 @@ CREATE TABLE "ur_ingest_session_plm_acct_label" (

## Relations

![er](../../../../../assets/ur_ingest_session_plm_acct_label.svg)
![er](../../../../../assets/images/content/docs/standard-library/rssd-schema/ur_ingest_session_plm_acct_label.svg)
Original file line number Diff line number Diff line change
Expand Up @@ -79,4 +79,4 @@ CREATE TABLE "ur_ingest_session_plm_acct_project" (

## Relations

![er](../../../../../assets/ur_ingest_session_plm_acct_project.svg)
![er](../../../../../assets/images/content/docs/standard-library/rssd-schema/ur_ingest_session_plm_acct_project.svg)
Original file line number Diff line number Diff line change
Expand Up @@ -127,4 +127,4 @@ CREATE TABLE "ur_ingest_session_plm_acct_project_issue" (

## Relations

![er](../../../../../assets/ur_ingest_session_plm_acct_project_issue.svg)
![er](../../../../../assets/images/content/docs/standard-library/rssd-schema/ur_ingest_session_plm_acct_project_issue.svg)
Original file line number Diff line number Diff line change
Expand Up @@ -68,4 +68,4 @@ CREATE TABLE "ur_ingest_session_plm_acct_relationship" (

## Relations

![er](../../../../../assets/ur_ingest_session_plm_acct_relationship.svg)
![er](../../../../../assets/images/content/docs/standard-library/rssd-schema/ur_ingest_session_plm_acct_relationship.svg)
Original file line number Diff line number Diff line change
Expand Up @@ -77,4 +77,4 @@ CREATE TABLE "ur_ingest_session_plm_comment" (

## Relations

![er](../../../../../assets/ur_ingest_session_plm_comment.svg)
![er](../../../../../assets/images/content/docs/standard-library/rssd-schema/ur_ingest_session_plm_comment.svg)
Original file line number Diff line number Diff line change
Expand Up @@ -67,4 +67,4 @@ CREATE TABLE "ur_ingest_session_plm_issue_reaction" (

## Relations

![er](../../../../../assets/ur_ingest_session_plm_issue_reaction.svg)
![er](../../../../../assets/images/content/docs/standard-library/rssd-schema/ur_ingest_session_plm_issue_reaction.svg)
Original file line number Diff line number Diff line change
Expand Up @@ -71,4 +71,4 @@ CREATE TABLE "ur_ingest_session_plm_issue_type" (

## Relations

![er](../../../../../assets/ur_ingest_session_plm_issue_type.svg)
![er](../../../../../assets/images/content/docs/standard-library/rssd-schema/ur_ingest_session_plm_issue_type.svg)
Original file line number Diff line number Diff line change
Expand Up @@ -74,4 +74,4 @@ CREATE TABLE "ur_ingest_session_plm_milestone" (

## Relations

![er](../../../../../assets/ur_ingest_session_plm_milestone.svg)
![er](../../../../../assets/images/content/docs/standard-library/rssd-schema/ur_ingest_session_plm_milestone.svg)
Original file line number Diff line number Diff line change
Expand Up @@ -61,4 +61,4 @@ CREATE TABLE "ur_ingest_session_plm_reaction" (

## Relations

![er](../../../../../assets/ur_ingest_session_plm_reaction.svg)
![er](../../../../../assets/images/content/docs/standard-library/rssd-schema/ur_ingest_session_plm_reaction.svg)
Original file line number Diff line number Diff line change
Expand Up @@ -67,4 +67,4 @@ CREATE TABLE "ur_ingest_session_plm_user" (

## Relations

![er](../../../../../assets/ur_ingest_session_plm_user.svg)
![er](../../../../../assets/images/content/docs/standard-library/rssd-schema/ur_ingest_session_plm_user.svg)
Original file line number Diff line number Diff line change
Expand Up @@ -81,4 +81,4 @@ CREATE TABLE "ur_ingest_session_task" (

## Relations

![er](../../../../../assets/ur_ingest_session_task.svg)
![er](../../../../../assets/images/content/docs/standard-library/rssd-schema/ur_ingest_session_task.svg)
Original file line number Diff line number Diff line change
Expand Up @@ -75,4 +75,4 @@ CREATE TABLE "ur_ingest_session_udi_pgp_sql" (

## Relations

![er](../../../../../assets/ur_ingest_session_udi_pgp_sql.svg)
![er](../../../../../assets/images/content/docs/standard-library/rssd-schema/ur_ingest_session_udi_pgp_sql.svg)
4 changes: 2 additions & 2 deletions src/content/docs/es/docs.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -13,8 +13,8 @@ hero:
tagline: ""
image:
alt: A Resource Surveliance Logo
dark: ../../../assets/_image.png
light: ../../../assets/_image.png
dark: ../../../assets/images/content/docs/_image.png
light: ../../../assets/images/content/docs/_image.png
actions:
- text: Resource Surveillance
icon: right-arrow
Expand Down
Loading

0 comments on commit 1083ef3

Please sign in to comment.