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

Docs enhancement #407

Closed
3 of 9 tasks
khaledyoussef24 opened this issue Jun 20, 2024 · 6 comments
Closed
3 of 9 tasks

Docs enhancement #407

khaledyoussef24 opened this issue Jun 20, 2024 · 6 comments
Assignees
Labels
documentation Improvements or additions to documentation
Milestone

Comments

@khaledyoussef24
Copy link

khaledyoussef24 commented Jun 20, 2024

Describe the bug

the docs are so generic.
can we cover more about

  • State import
  • Output values
  • Secret management
  • the examples
  • how to add public ip
  • mycelium ip
  • max and min memory
  • cpu
  • how to use flists
@rawdaGastan
Copy link
Collaborator

You can check https://www.pulumi.com/registry/packages/threefold/api-docs/provider/
Also there is a Makefile with every example to be able to run it

@rawdaGastan rawdaGastan self-assigned this Jun 23, 2024
@rawdaGastan rawdaGastan added the documentation Improvements or additions to documentation label Jun 23, 2024
@rawdaGastan rawdaGastan added this to the v0.7.0 milestone Jun 23, 2024
@khaledyoussef24
Copy link
Author

Yes , I found it is very helpful.
But i wanted to use mycelium ip and public ip but I couldn't went through docs couldn't understand it and went through code found a couple of commented codes shall i only un-comment them ?

@khaledyoussef24
Copy link
Author

Will try the makefile and comment again

@khaledyoussef24
Copy link
Author

can we add docs for upgrading an existed vm
and also add more info for these fields(disk size , cpus , memory) like max and min
as mentioned here #468 so i can produce
Screenshot 2024-08-19 at 4 06 41 PM
Screenshot 2024-08-19 at 4 07 17 PM

and planetary shall be removed i think
Screenshot 2024-08-19 at 4 07 04 PM

@khaledyoussef24
Copy link
Author

khaledyoussef24 commented Aug 20, 2024

can we also add docs for
State import
Output values
Secret management

@xmonader
Copy link
Contributor

@khaledyoussef24 either you have the issues in different tickets or all in the issue body (not in separate comments)

@rawdaGastan rawdaGastan modified the milestones: v0.7.0, v0.8.0 Aug 20, 2024
@rawdaGastan rawdaGastan moved this to Accepted in 3.15.x Sep 5, 2024
@rawdaGastan rawdaGastan moved this from Pending Review to In Verification in 3.15.x Sep 24, 2024
@rawdaGastan rawdaGastan modified the milestones: v0.8.0, v0.7.x Sep 25, 2024
@github-project-automation github-project-automation bot moved this from In Verification to Done in 3.15.x Sep 30, 2024
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
Status: Done
Development

No branches or pull requests

3 participants