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.

Sign up for GitHub

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

Jump to bottom

Review and improve documentation #478

Closed
NFSS10 opened this issue Feb 14, 2023 · 1 comment
Closed

Review and improve documentation #478

NFSS10 opened this issue Feb 14, 2023 · 1 comment
Assignees
@3rdvision
Labels
CSR documentation Issue requires new documentation enhancement New feature or request

Comments

@NFSS10
Copy link
Contributor

NFSS10 commented Feb 14, 2023 •
edited
Loading

Rationale

The RIPE-SDK documentation is lacking in some aspects such as examples and demos that could help an external person to easily dive in and start using it.

Description

Analyze and check what can be improved with the documentation and maybe create some demos and improve the examples on how to use the SDK, namely the configurator and each of the strategies (PRC and CSR)
@NFSS10 NFSS10 changed the title Documentation Review and improve SDK documentation Feb 14, 2023
@NFSS10 NFSS10 added enhancement New feature or request documentation Issue requires new documentation CSR labels Feb 14, 2023
@NFSS10 NFSS10 self-assigned this Feb 14, 2023
@NFSS10 NFSS10 changed the title Review and improve SDK documentation Review and improve documentation Feb 14, 2023
@NFSS10 NFSS10 removed their assignment Feb 14, 2023
@3rdvision 3rdvision self-assigned this Feb 16, 2023
@NFSS10
Copy link
Contributor Author

NFSS10 commented Feb 16, 2023

I have a personal repository with some simple examples of RIPE-SDK: https://github.com/NFSS10/ripe-sdk-examples
It may be useful!

@3rdvision 3rdvision mentioned this issue Mar 1, 2023
Merged
3rdvision added a commit that referenced this issue Mar 2, 2023
@3rdvision
Merge pull request #492 from ripe-tech/dva/479-csr_documentation
f6edee3 
#478 Add CSR alt documentation
@3rdvision 3rdvision mentioned this issue Mar 2, 2023
Merged
3rdvision added a commit that referenced this issue Mar 2, 2023
@3rdvision
Merge pull request #496 from ripe-tech/dva/fix_documentation
749c95c 
#478 Fix CSR documentation compilation
@3rdvision 3rdvision mentioned this issue Mar 2, 2023
Merged
3rdvision added a commit that referenced this issue Mar 2, 2023
@3rdvision
Merge pull request #497 from ripe-tech/dva/add_docs_csr_dockerfile
d255b0d 
#478 Add CSR documentation `Dockerfile`
@3rdvision 3rdvision mentioned this issue Mar 8, 2023
Merged
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees

@3rdvision 3rdvision

Labels
CSR documentation Issue requires new documentation enhancement New feature or request
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
2 participants
@NFSS10 @3rdvision