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

[BUG]Update documentation #1061

Open
prasadtalasila opened this issue Nov 15, 2024 · 3 comments
Open

[BUG]Update documentation #1061

prasadtalasila opened this issue Nov 15, 2024 · 3 comments
Labels
bug Something isn't working documentation Improvements or additions to documentation

Comments

@prasadtalasila
Copy link
Contributor

prasadtalasila commented Nov 15, 2024

Describe the bug

The following documentation is out of date:

  1. Client config. The REACT_APP_WORKBENCHLINK_DT_PREVIEW is missing in some places.
  2. Each release must have fixed npm and docker versions in all places. At present, the npm install and custom docker compose files in client and servers do not have their versions fixed. In addition, the docs need to be updated as well.
  3. Developer documentation needs to be updated for latest code of all the packages.
  4. DevOps documentation from Vanessa's thesis need to be integrated
  5. Port updates in documentation from release-v0.6 branch to feature/distributed-demo branch.
@prasadtalasila prasadtalasila added bug Something isn't working documentation Improvements or additions to documentation labels Nov 15, 2024
@prasadtalasila prasadtalasila added this to the Release v0.7.0 milestone Nov 15, 2024
@prasadtalasila
Copy link
Contributor Author

Libms has git mode and yaml config. This needs to be reflected in the docs

@prasadtalasila
Copy link
Contributor Author

prasadtalasila commented Dec 11, 2024

Documentation for preview/digitaltwins page

  1. Integrate runner
  2. Remember to have atleast one pipeline trigger token
  3. Always have main branch. The Create and Manage DT tabs work on any default branch but Execute works only on branch with name as main.

@prasadtalasila
Copy link
Contributor Author

Documentation for preview/library page

  1. Have a dtaas group in the integrated gitlab instance
  2. Have a gitlab repository in dtaas group with username as repository name. For example, user1 username must have a repository at https://foo.com/gitlab/dtaas/user1.git. Create a branch named main and make this the default branch.
  3. Create a PAT - personal access token with a name, for example your username (say user1).
  4. Use it to clone and work with the repository. The repository will be accessible using the URL: https://<PAT-name>:<token-value>:foo.com/gitlab/dtaas/user1.git. Use regular git workflows for commit, push and pull content.
  5. Remember to create a branch named main and push content to the same. Now the workflows from React website and the git are synchronized.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
bug Something isn't working documentation Improvements or additions to documentation
Projects
Status: Backlog
Development

No branches or pull requests

1 participant