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

Explain how versioning works with different objects #76

Open
MattDodsonEnglish opened this issue Feb 20, 2024 · 4 comments
Open

Explain how versioning works with different objects #76

MattDodsonEnglish opened this issue Feb 20, 2024 · 4 comments
Labels
content needed plans to fill in content gaps

Comments

@MattDodsonEnglish
Copy link
Collaborator

It can be a bit tricky to understand when and why certain objects require new versions. An explainer doc could help out, with links from model reference.

@MattDodsonEnglish MattDodsonEnglish added the content needed plans to fill in content gaps label Feb 23, 2024
@MattDodsonEnglish
Copy link
Collaborator Author

Also explain how Rhize supports or deviates from standard.

@MattDodsonEnglish
Copy link
Collaborator Author

Probably could be three docs: explanation, how-to, reference.

  • Explanation template

    # Rhize Versioning
    
    ## Versions in Rhize
    
    <How Rhize versioning works>
    
    ## Why version
    
    ## Compared with ISA-95
    <how and why Rhize deviates>
  • How-to

    ## Change versions
    
    ##  Change versions in UI
    
    1. 
    1. ON successs
    
    ## Change versions with GQL
    
    1.
    1. 
    
  • Reference

    ## Versioned objects
    
    The following objects support versions
    
    ## Version states
    
    

@MattDodsonEnglish MattDodsonEnglish added the high priority Always prioritize these issues label Mar 4, 2024
@MattDodsonEnglish
Copy link
Collaborator Author

These docs should have backlinks from Model reference, and Upsert GQL doc.

@MattDodsonEnglish
Copy link
Collaborator Author

Some version mutations:

  • Create_x_version. Creates a new version with the id and version number aligned. Related to Document create operation #63
  • Save_x_VersionAs Performs a deep copy of a version and saves it:
  • Update_x_VersionState
    • to Draft, Active, Deprecated
    • Rewires the ‘isActiveVersionOf’ relationship

@MattDodsonEnglish MattDodsonEnglish removed the high priority Always prioritize these issues label Apr 9, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
content needed plans to fill in content gaps
Projects
None yet
Development

No branches or pull requests

1 participant