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.

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 documentation #483

Closed
prasadtalasila opened this issue Jan 27, 2024 · 18 comments
Closed

Update documentation #483

prasadtalasila opened this issue Jan 27, 2024 · 18 comments
Assignees
Labels
documentation Improvements or additions to documentation

Comments

@prasadtalasila
Copy link
Contributor

The following updates must be made:

docs
  add documentation for docker install
  libms http mode
  add use of containers to admin docs
  add images of libms http mode to user docs
@prasadtalasila prasadtalasila added the documentation Improvements or additions to documentation label Jan 27, 2024
@prasadtalasila
Copy link
Contributor Author

prasadtalasila commented Feb 18, 2024

docs
  admin
    docker + traefik forward-auth
    lib http mode
  developer
    current status
     oauth.md
     publish
         npm
         docker
  user
    website
    lib http mode
    FAQ
  • oauth2 explanation (replace authentication word with authorization)

@prasadtalasila
Copy link
Contributor Author

Update package names in developer documentation (ex: publish npm packages page) to @into-cps-association/*

@prasadtalasila
Copy link
Contributor Author

Link this image to testing page.

@prasadtalasila
Copy link
Contributor Author

Further suggestions on the updates to documentation are available on wiki

@prasadtalasila
Copy link
Contributor Author

The lib container does not work behind traefik forward-auth. This limitation needs to be documented as well.

@prasadtalasila
Copy link
Contributor Author

add DTaaS logo to top-level redirection page html

@prasadtalasila
Copy link
Contributor Author

Add

REACT_APP_CLIENT_ID: '1be55736756190b3ace4c2c4fb19bde386d1dcc748d20b47ea8cfb5935b8446c'

on Gitlab OAuth (ex: localhost installation) and client env.js pages. Leaving this field empty in tables is confusing to users.

@prasadtalasila
Copy link
Contributor Author

add DTaaS logo to top-level redirection page html

done

@prasadtalasila
Copy link
Contributor Author

Correct path mistake of CLIENT_CONFIG in docker README

@prasadtalasila
Copy link
Contributor Author

Add documentation for publishing docker images under developer section. The relevant info is in docker/README.md

@prasadtalasila
Copy link
Contributor Author

The figure on production install is wrong.

@prasadtalasila
Copy link
Contributor Author

Three new examples have been added to DTaaS-Examples in this pull request. This documentation needs to be brought into examples documentation.

@prasadtalasila
Copy link
Contributor Author

prasadtalasila commented May 26, 2024

Add

REACT_APP_CLIENT_ID: '1be55736756190b3ace4c2c4fb19bde386d1dcc748d20b47ea8cfb5935b8446c'

on Gitlab OAuth (ex: localhost installation) and client env.js pages. Leaving this field empty in tables is confusing to users.

done

@prasadtalasila
Copy link
Contributor Author

The deploy/config/lib.docker does not need to be modified. The installation instructions need to be updated accordingly.

@prasadtalasila
Copy link
Contributor Author

Instructions on creating files/ are required on https://into-cps-association.github.io/DTaaS/development/admin/cli.html page

@prasadtalasila
Copy link
Contributor Author

prasadtalasila commented Jun 5, 2024

Pending documentation tasks:

docs
  admin
    cli (instruction on creating user directories, caveats)
    client
       config
    docker
       host (add warning about file visibility in HTTP mode)
    servers
      auth
      lib
         npm.md
         docker.md

  users
    website (remove **Terminal** from explanation)
     servers/lib/LIB-MS.md (move the information note to graphql sub-section)

  developer
    current status
     oauth.md (pkce vs web server workflows)
     CLI
     publish
         npm
         docker
    testing
      intro: link [this image](https://images.ctfassets.net/xz1dnu24egyd/v4OXD3J1HKrhPdBtvOhi2/1f9a3907b1098c49e45533148360903d/cost-savings-to-shift-left.png)
    FAQ

Other Tasks:

  • Fix errors pointed out by Nick Battle
  • Check the HTTP authentication text in all of the docs
  • Rename "Developer/Components** in navigation bar to Packages.

@prasadtalasila
Copy link
Contributor Author

prasadtalasila commented Jun 16, 2024

Pending documentation tasks after merging PR #811 :

docs
  admin
    client
       config
    docker
       host (add warning about file visibility in HTTP mode)
    servers
      lib
         npm.md
         docker.md

  users
    website (remove **Terminal** from explanation)
     servers/lib/LIB-MS.md (move the information note to graphql sub-section)

  developer
    current status
    testing
      intro: link [this image](https://images.ctfassets.net/xz1dnu24egyd/v4OXD3J1HKrhPdBtvOhi2/1f9a3907b1098c49e45533148360903d/cost-savings-to-shift-left.png)
    FAQ

Other Tasks:

  • Fix errors pointed out by Nick Battle
  • Check the HTTP authentication text in all of the docs
  • Rename "Developer/Components** in navigation bar to Packages.

@prasadtalasila
Copy link
Contributor Author

PR #823 completes the documentation

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation
Projects
None yet
Development

No branches or pull requests

2 participants