Commit 7e18b755 authored by Robert Ricci's avatar Robert Ricci

Move profile versioning out of the 'planned features' chapter

parent 4b8fcb15
......@@ -323,8 +323,6 @@ fields in the RSpec.
@section[#:tag "sharing-profiles"]{Sharing Profiles}
@future-work["planned-versioned-profiles"]
If you chose to make your profile publicly visible, it will show up in the main
``Select Profile'' list on @url[(apturl)]. @(tb) also gives you direct links to
your profiles so that you can share them with others, post them on your
......@@ -336,3 +334,17 @@ public, the URL will have the form @code[(apturl "/p/<UUID>")], where
@code{UUID} is a 128-bit number so that the URL is not guessable. You can still
share this URLs with anyone you want to have access to the profile---for
example, to give it to a collaborator to try out your work before publishing.
@section[#:tag "versioned-profiles"]{Versioned Profiles}
Profiles are @italic{versioned} to capture the evolution
of a profile over time. When @seclink["updating-profiles"]{updating profiles},
the result is be a new version that does not (entirely) replace the profile
being updated.
When @seclink["sharing-profiles"]{sharing a profile}, you are given two links
to share. One link will take the user to the most recent version of the profile
that exists at the time they click the link. This is the most appropriate
option in most cases. There is also a link that takes one to a specific version
of the profile. This link is most useful for publication in papers or other
cases in which reproducability with the exact same environment is a concnern.
......@@ -8,25 +8,6 @@ This chapter describes features that are planned for @(tb) or under development:
please @seclink["getting-help"]{contact us} if you have any feedback or
suggestions!
@section[#:tag "planned-versioned-profiles"]{Versioned Profiles}
We plan to add the @italic{versioning} to profiles to capture the evolution
of a profile over time. When @seclink["updating-profiles"]{updating profiles},
the result will be a new version that does not (entirely) replace the profile
being updated.
There will be two types of versions: @italic{working} versions that should be
considered ephemeral, and @italic{published} versions that are intended to be
long-term stable. For example, a user may generate many working versions as
they refine their software, fix bugs, etc. Then, when the profile is in a state
where it is appropriate to share with others, it can be published. Users will
be able to link to a specific version---example, to unambiguously identify which
version was used for a paper.
One limitation on this feature will be the fact that @(tb) has limited storage
space; we will have to apply a quota system that limits the amount of storage
that a project can use to store multiple versions of the same profile.
@section[#:tag "planned-persistent-storage"]{Persistent Storage}
For the time being, the contents of all disks in @(tb) are considered ephemeral:
......
Markdown is supported
0% or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment