diff --git a/planning/api2.md b/planning/api2.md index c8881e4ecc..f0e801ff7d 100644 --- a/planning/api2.md +++ b/planning/api2.md @@ -1,7 +1,11 @@ API Overview ============ -The following is a start to an API document. It is just a sketch and may evolve as we build things out. +This was an early sketch of the API. + +Just use this as an idea of what we want to shoot for, +there will be formal API docs soon. + Versioning and Semantics ======================== diff --git a/planning/mockups.md b/planning/mockups.md deleted file mode 100644 index 3c9ac47755..0000000000 --- a/planning/mockups.md +++ /dev/null @@ -1,88 +0,0 @@ - -User default view -- buttons appear/disappear based on permissions -/web/home - - [TEAMS] -- all teams with permissions shown here - t1 [ view ] [ edit ] - t2 [ view ] [ edit ] - [+ create team] - - [PROJECTS] -- all projects with permissions shown here - () p1 [ view ] [ edit ] - () p2 [ view ] [ edit ] - () p3 [ view ] [ edit ] - [+ create project] - - [INVENTORIES] -- all inventories with permissions shown here - () i1 [ view ] [ edit ] - () i2 [ view ] [ edit ] - [+ create inventory] - - [CREDENTIALS] -- team and user creds shown here - () c1 [ view ] [ edit ] - () c2 [ view ] [ edit ] - [+ user cred] - -Org Page Edit/View -/web/org/#{org_id} - - [ users listing/adding/deleting admin widget ] -- can add/see users if org admin - [ projects listing/adding/deleting admin widget ] -- can add/see if org admin - -Team Page Edit/View -/web/team/#{team_id} - - [ users listing/adding/deleting admin widget ] -- can add if org admin, can see if on team - [ credentials listing/adding/deleting admin widget ] -- can create/edit team creds here if on team - [ projects listing/adding/deleting admin widget ] -- can add existing proj to team if org admin, see if on team - - -Project Page Edit/View -/web/project/#{project_id} - - see what teams share this project, links to them - [ view/edit properties ] - - [ PUSH ] [ CHECK ] buttons - must select an inventory source - must select a credential the user or team has for that source - in order to enable - - clicking button gets you a link to the page in events - -Events Page -/web/events/ - - you can see all the events on things you have inventory - access for. - -Jobs Page -/web/jobs - - you can see all the pages you have inventory access for - -Inventory Page Edit/View -/web/inventory/#{inventory_id} - - [ groups listing/adding/deleting widget ] - [ hosts listing/adding/deleting widget ] - [ links on each host to log data ] - -Individual edit pages - - what you can do varies by access level - -/web/hosts/N -/web/groups/N -/web/users/N - -/web/projects/N - - viewer and editor as appropriate - for filesystem tree - will presumably NOT be super-graphical/editable in additional round - Cloud9 IDE? - - - -` diff --git a/planning/use_cases.md b/planning/use_cases.md index 08aff12215..1225dd2ac7 100644 --- a/planning/use_cases.md +++ b/planning/use_cases.md @@ -1,3 +1,10 @@ +About +===== + +This was an early doc of some of the things we want to be able to do. +As database and plans change, this is not neccessarily our most up +to date plan, but leaving this here for reference. + Roles =====