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

Use-Cases and Examples showing how vocab can be used #12

Open
Tracked by #50
coolharsh55 opened this issue Jun 24, 2021 · 5 comments
Open
Tracked by #50

Use-Cases and Examples showing how vocab can be used #12

coolharsh55 opened this issue Jun 24, 2021 · 5 comments
Assignees
@coolharsh55
Labels
documentation Improvements or additions to documentation help-wanted Assistance in performing tasks for this issue review Review and close/update issue todo chores, tasks, things to do use-case Use-case and Application
Milestone
dpv v2.1

Comments

@coolharsh55
Copy link
Collaborator

coolharsh55 commented Jun 24, 2021 •
edited

| Migrated ISSUE-26: Describe use-cases and examples showing how the vocabulary should be or can be used

State: OPEN
Opened on: 2019-06-18
@coolharsh55 coolharsh55 added the documentation Improvements or additions to documentation label Jun 24, 2021
@coolharsh55 coolharsh55 self-assigned this Jun 24, 2021
@coolharsh55
Copy link
Collaborator Author

Proposal for this is to have use-cases be descriptive i.e. what should happen and examples represent the information using DPV (i.e. in RDF). Each gets an identifier of the form dpv/use-cases/U0001. Use-cases are annotated with contextually relevant concepts (i.e. what that use-case is about). The documentation generator will then link relevant use-cases and examples alongside each concept. Probably needs a lot of time to implement.

@coolharsh55 coolharsh55 added the help-wanted Assistance in performing tasks for this issue label Jun 9, 2022
@coolharsh55
Copy link
Collaborator Author

(Thanks to Jan, Paul - meeting MAR-02) We have the following structure for use-cases:

  1. ID
  2. Title
  3. Description
  4. Relevant Concepts (list which terms are used AND which may require additions)
  5. Source (external reference to use case and indicate if deployed or research project)
  6. Contributed by and when

@coolharsh55 coolharsh55 added this to the DPV v1 milestone Jun 30, 2022
@coolharsh55
Copy link
Collaborator Author

Proposal on mailing list JUN-10 https://lists.w3.org/Archives/Public/public-dpvcg/2022Jun/0006.html

coolharsh55 added a commit that referenced this issue Oct 9, 2022
@coolharsh55
007 Use-Cases and Requirements
c7927d5 
- Adds 007.py script for generating use-cases and requirements
- Export is in /use-cases and contains ucr.ttl and ucr.html
- Import is from CSV files
- Generated output is a list of use-cases, requirements, relevant
  concepts as subjects of these - and interlinks between them.
- This also sets out the framework for generating Examples page with
  similar scripting and export processes
- See #12 for issue on this topic
@coolharsh55 coolharsh55 added use-case Use-case and Application todo chores, tasks, things to do review Review and close/update issue labels Oct 9, 2022
coolharsh55 added a commit that referenced this issue Oct 12, 2022
@coolharsh55
008 Examples
54e7138 
- Adds 008.py script for generating examples.ttl index and creating the
  documentation page for all examples
- Links examples with relevant concepts and vice-versa in documentation
- If example entry specifies it should be embedded in page, reads the
  source path and creates code blocks in documentation
- Generated output is in /examples path, and contains examples.ttl as
  the index, with individual files representing examples (suggested
  prefix Exxxx), and HTML documentation
- See #12 for issue on this topic
@coolharsh55
Copy link
Collaborator Author

See mailing list https://lists.w3.org/Archives/Public/public-dpvcg/2022Oct/0003.html for stubs proposed

use-cases & requirements: https://harshp.com/dpv-x/use-cases/
examples: https://harshp.com/dpv-x/examples/
data spreadsheet: https://docs.google.com/spreadsheets/d/1__STWvOEZRc1u2J-8teOYjLpnTPlZ80_ebTytrUlWgQ

coolharsh55 added a commit that referenced this issue Oct 22, 2022
@coolharsh55
007 Use-Cases and Requirements
441e137 
- Adds 007.py script for generating use-cases and requirements
- Export is in /use-cases and contains ucr.ttl and ucr.html
- Import is from CSV files
- Generated output is a list of use-cases, requirements, relevant
  concepts as subjects of these - and interlinks between them.
- This also sets out the framework for generating Examples page with
  similar scripting and export processes
- See #12 for issue on this topic
coolharsh55 added a commit that referenced this issue Oct 22, 2022
@coolharsh55
008 Examples
fb15f21 
- Adds 008.py script for generating examples.ttl index and creating the
  documentation page for all examples
- Links examples with relevant concepts and vice-versa in documentation
- If example entry specifies it should be embedded in page, reads the
  source path and creates code blocks in documentation
- Generated output is in /examples path, and contains examples.ttl as
  the index, with individual files representing examples (suggested
  prefix Exxxx), and HTML documentation
- See #12 for issue on this topic
@coolharsh55 coolharsh55 mentioned this issue Oct 22, 2022
Closed
35 tasks
@besteves4
Copy link
Collaborator

Hi.
I have one new example here with turtle here.
Also two use-cases U4 and U5 (with example turtles here and here, respectively) with two new requirements R4 and R5.

@coolharsh55 coolharsh55 removed this from the DPV v1 milestone May 10, 2023
@coolharsh55 coolharsh55 added this to the dpv v2.1 milestone Apr 13, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees

@coolharsh55 coolharsh55

Labels
documentation Improvements or additions to documentation help-wanted Assistance in performing tasks for this issue review Review and close/update issue todo chores, tasks, things to do use-case Use-case and Application
Projects
None yet
Milestone
dpv v2.1
Development

No branches or pull requests
2 participants
@coolharsh55 @besteves4