Adds new documentation #803

prasadtalasila · 2024-06-04T16:35:33Z

Builds on PR #786

Updates documentation on packages
Corrects admin documentation
Edits images on the user website documentation page

Corrects admin documentation Edits images on the user website documentation page

codeclimate · 2024-06-04T16:36:16Z

docs/admin/servers/auth.md

+    |Application ID|CLIENT_ID| _xx_ |
+    |Application Secret|CLIENT_SECRET| _xx_ |
+    |Callback URL|(to be directly entered in Gitlab OAuth registration)||
+    |Forward-auth secret|OAUTH_SECRET|_random-secret-string_ (password for forward-auth, can be changed to your preferred string) |


Line length

codeclimate · 2024-06-04T16:36:16Z

docs/admin/guides/remove_user.md

+
+   - Go to the _docker_ directory
+
+      ```bash


Code block style

codeclimate · 2024-06-04T16:36:16Z

docs/admin/guides/remove_user.md

+
+   - Remove these three lines from the `conf.server` file
+
+      ```txt


Code block style

codeclimate · 2024-06-04T16:36:16Z

docs/admin/guides/remove_user.md

+
+   - Run the command for these changes to take effect:
+
+      ```bash


Code block style

codeclimate · 2024-06-04T16:36:16Z

docs/admin/guides/add_user.md


-**3. Add username and password:**
+   2. Add three lines to the `conf.server` file


Ordered list item prefix

prasadtalasila · 2024-06-04T16:40:46Z

docs/admin/servers/auth.md

The formatting is off when this page is rendered as html

Fixes codeclimate issues on existing docs

codeclimate · 2024-06-05T06:11:25Z

docs/admin/guides/remove_user.md

+
+   - Go to the _docker_ directory
+
+     ```bash


Code block style

codeclimate · 2024-06-05T06:11:25Z

docs/admin/guides/remove_user.md

+
+   - Remove these three lines from the `conf.server` file
+
+     ```txt


Code block style

codeclimate · 2024-06-05T06:11:26Z

docs/admin/guides/remove_user.md

+
+   - Run the command for these changes to take effect:
+
+     ```bash


Code block style

codeclimate · 2024-06-05T06:11:26Z

docs/admin/guides/add_user.md

-  --restart always \
-  mltooling/ml-workspace-minimal:0.13.2
-```
+     ```bash


Code block style

codeclimate · 2024-06-05T06:11:26Z

docs/admin/guides/add_user.md


-The following code adds basic authorization for the new user.
+     ```txt


Code block style

codeclimate · 2024-06-05T07:55:47Z

docs/admin/servers/auth.md

+       Select option to generate client secret and also selection option
+       for trusted application.
+
+2. **Determine Website Hostname**  


Trailing spaces

codeclimate · 2024-06-05T07:55:47Z

docs/admin/servers/auth.md

+   It's recommended to use a self-hosted GitLab instance, which you will use in
+   other parts of the DTaaS application.
+
+3. **Determine Callback and Logout URLs**  


Trailing spaces

codeclimate · 2024-06-05T07:55:47Z

docs/admin/servers/auth.md

+     The logout URL is to help users logout of traefik forward-auth. The logout
+     URL should not be entered into Gitlab OAuth application setup.
+
+4. **Create OAuth Application**  


Trailing spaces

codeclimate · 2024-06-05T07:55:47Z

docs/admin/servers/auth.md

+
+     ![Creation of Server OAuth Application](server-oauth.png)
+
+5. **Copy Application Credentials**  


Trailing spaces

codeclimate · 2024-06-05T07:55:47Z

docs/admin/servers/auth.md

+     ![Server OAuth Application Credentials](server-oauth2.png)
+
+<!-- markdownlint-disable MD013 -->
+1. **Checklist: Required Information from OAuth Application:**  


Trailing spaces

Updates libms docs

codeclimate · 2024-06-05T08:56:07Z

docs/admin/servers/auth.md

-|GitLab Variable Name|Variable Name in .env of docker compose file |Default Value|
-|---|---|---|
+<!-- markdownlint-disable MD013 -->
+| GitLab Variable Name | Variable Name in .env of docker compose file | Default Value |


Line length

codeclimate · 2024-06-05T08:56:07Z

docs/admin/client/auth.md

@@ -35,17 +29,21 @@ Here are the steps to get started:
  homepage of the DTaaS application.
 - The logout URL is where users will be directed after logging out.

-**4. OAuth Application Creation:**
+**4. OAuth Application Creation:**  


Trailing spaces

codeclimate · 2024-06-05T08:56:07Z

docs/admin/guides/add_user.md


-**4. Add 'route' for new user:**
+    ```bash


Code block style

codeclimate · 2024-06-05T09:05:29Z

docs/admin/guides/remove_user.md

+
+Please do the following:
+
+**1. Remove an existing user with the [DTaaS CLI](../cli.md)**


Emphasis used instead of a header

codeclimate · 2024-06-05T09:09:33Z

Code Climate has analyzed commit a551e6d and detected 2 issues on this pull request.

Here's the issue category breakdown:

Category	Count
Style	2

View more on Code Climate.

astitva1905 and others added 4 commits June 4, 2024 15:05

docker documentation

620df14

Removes redundant docs and adds User docs

e474d51

Updates and cleans admin docs

3ca346c

Updates documentation on packages

353f661

Corrects admin documentation Edits images on the user website documentation page

codeclimate bot reviewed Jun 4, 2024

View reviewed changes

prasadtalasila commented Jun 4, 2024

View reviewed changes

docs/admin/servers/auth.md

Copy link

Contributor Author

prasadtalasila Jun 4, 2024

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The formatting is off when this page is rendered as html

Adds documentation for three new examples

67b88bc

Fixes codeclimate issues on existing docs

codeclimate bot reviewed Jun 5, 2024

View reviewed changes

Adds screenshots to OAuth docs

5d56418

codeclimate bot reviewed Jun 5, 2024

View reviewed changes

Fixes codeclimate issues

c3e3164

Updates libms docs

codeclimate bot reviewed Jun 5, 2024

View reviewed changes

Fixes codeclimate issues

674cef5

codeclimate bot reviewed Jun 5, 2024

View reviewed changes

Fixes codeclimate issues

a551e6d

prasadtalasila merged commit 89c9125 into INTO-CPS-Association:feature/distributed-demo Jun 5, 2024
5 checks passed

prasadtalasila mentioned this pull request Jun 5, 2024

User Documentation #786

Closed

prasadtalasila deleted the pr-786 branch June 19, 2024 06:31

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Adds new documentation #803

Adds new documentation #803

prasadtalasila commented Jun 4, 2024

codeclimate bot Jun 4, 2024

codeclimate bot Jun 4, 2024

codeclimate bot Jun 4, 2024

codeclimate bot Jun 4, 2024

codeclimate bot Jun 4, 2024

prasadtalasila Jun 4, 2024

codeclimate bot Jun 5, 2024

codeclimate bot Jun 5, 2024

codeclimate bot Jun 5, 2024

codeclimate bot Jun 5, 2024

codeclimate bot Jun 5, 2024

codeclimate bot Jun 5, 2024

codeclimate bot Jun 5, 2024

codeclimate bot Jun 5, 2024

codeclimate bot Jun 5, 2024

codeclimate bot Jun 5, 2024

codeclimate bot Jun 5, 2024

codeclimate bot Jun 5, 2024

codeclimate bot Jun 5, 2024

codeclimate bot Jun 5, 2024

codeclimate bot commented Jun 5, 2024


		- Remove these three lines from the `conf.server` file

		```txt


		3. Add username and password:
		2. Add three lines to the `conf.server` file


		The following code adds basic authorization for the new user.
		```txt


		![Creation of Server OAuth Application](server-oauth.png)

		5. Copy Application Credentials


		Please do the following:

		1. Remove an existing user with the [DTaaS CLI](../cli.md)

Adds new documentation #803

Adds new documentation #803

Conversation

prasadtalasila commented Jun 4, 2024

codeclimate bot Jun 4, 2024

Choose a reason for hiding this comment

codeclimate bot Jun 4, 2024

Choose a reason for hiding this comment

codeclimate bot Jun 4, 2024

Choose a reason for hiding this comment

codeclimate bot Jun 4, 2024

Choose a reason for hiding this comment

codeclimate bot Jun 4, 2024

Choose a reason for hiding this comment

prasadtalasila Jun 4, 2024

Choose a reason for hiding this comment

codeclimate bot Jun 5, 2024

Choose a reason for hiding this comment

codeclimate bot Jun 5, 2024

Choose a reason for hiding this comment

codeclimate bot Jun 5, 2024

Choose a reason for hiding this comment

codeclimate bot Jun 5, 2024

Choose a reason for hiding this comment

codeclimate bot Jun 5, 2024

Choose a reason for hiding this comment

codeclimate bot Jun 5, 2024

Choose a reason for hiding this comment

codeclimate bot Jun 5, 2024

Choose a reason for hiding this comment

codeclimate bot Jun 5, 2024

Choose a reason for hiding this comment

codeclimate bot Jun 5, 2024

Choose a reason for hiding this comment

codeclimate bot Jun 5, 2024

Choose a reason for hiding this comment

codeclimate bot Jun 5, 2024

Choose a reason for hiding this comment

codeclimate bot Jun 5, 2024

Choose a reason for hiding this comment

codeclimate bot Jun 5, 2024

Choose a reason for hiding this comment

codeclimate bot Jun 5, 2024

Choose a reason for hiding this comment

codeclimate bot commented Jun 5, 2024