Commit 94fdea3a authored by Robert Ricci's avatar Robert Ricci

Add a few things noted by Leigh, and fix a few readability issues

parent f64f3724
Pipeline #2128 passed with stages
in 3 minutes and 3 seconds
......@@ -219,7 +219,7 @@ click a blank area of the canvas.
@section[#:tag "repo-based-profiles"]{Repository-Based Profiles}
You can turn any public @tt{git} repository (including those hosted on GitHub)
into a @(tb) profile. Simply place a @tt{geni-lib} (@secref["geni-lib"]) script
into a @(tb) profile. Simply place a @tt{geni-lib} script
named @tt{profile.py} into the top-level directory of your repository. When
you create a new profile, you can provide the URL for your repository. The URL
needs to be a @tt{http://} or @tt{https://} URL, and the CloudLab portal needs
......@@ -228,7 +228,8 @@ to be able to clone the repository without authentication.
@margin-note{
Note that CloudLab is not a @tt{git} hosting service; while we do keep a
cache of your repository, we don't guarantee that the profile will continue
to work if the original repository becomes unavailable.
to work if the original repository becomes unavailable. We also have limits
on the size of the repositories that we will clone.
}
When you intantiate a repository-based profile, the repository will be cloned
......@@ -240,6 +241,11 @@ a suitable @tt{push} URL for (it assumes that the hosting service uses @tt{ssh}
for pushes, and uses the @tt{git@"@"<hostname>:user/repo} convention). As a
result, @tt{git pull} and @tt{git push} should be connected to your repository.
There is an example repository on GitHub at
@hyperlink["https://github.com/emulab/my-profile"]{@tt{https://github.com/emulab/my-profile}}; if you don't already have a @tt{git} repository created, a good
way to get started is to for this one and crate a new profile pointing at your
fork.
@margin-note{
Pushing to your repository is still govered by the authentication and
permissions of your @tt{git} hosting service, so others using your profile
......@@ -268,7 +274,7 @@ time you push to your repository, your hosting service will let @(tb) know
that it should automatically initiate a pull. (This will not be instantaneous,
but should complete quickly in most cases.)
@subsection{Branches and Tags Repository-Based Profiles}
@subsection{Branches and Tags in Repository-Based Profiles}
By default, repository-based profiles will be instaniated from the @tt{master}
branch. At the bottom of the profile page, you will also find a list of all
......
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