Revises files to clarify purpose and to add references to swupd-guide.

Signed-off-by: Michael Vincerra <michael.vincerra@intel.com>
This commit is contained in:
Michael Vincerra
2018-08-13 12:12:19 -07:00
parent fd33bb2f79
commit 5a33a42730
2 changed files with 34 additions and 28 deletions
@@ -3,31 +3,34 @@
Developer Workstation
#####################
Workstation Setup
*****************
Overview
********
*Workstation Setup* helps you, the developer, find the tools you need. Use
the *Clear Linux Developer Profiles* (Table 1) to help you decide which bundles, at minimum, you need to set up your developer workstation.
*Developer Workstation* helps you find the tools you need to
set up your developer workstation.
We recommend using :ref:`swupd-search` to jump-start your skills using
core |CL| features like `swupd`.
First, we recommend learning how to use :ref:`swupd <swupd-guide>`.
:ref:`swupd search <swupd-search>` shows:
Next, check out :ref:`swupd search <swupd-search>`, which shows:
* How to use `swupd` commands
* How to search for bundles (that contain packages)
* How to add bundles
* How to use `swupd` to search for bundles
* How to use `swupd` to add bundles
How to use this document
========================
As a Developer, you could add the bundle `os-clr-on-clr` found in
:ref:`enable-user-space`. However, you may want to deploy a leaner OS with
only the bundles you need. This guide helps you get started.
This guide helps you understand the minimum bundles required to get started.
After installing them, you can add more bundles relevant to your use
case. To run any process required for Clear Linux developement, you may want
to add the large bundle :ref:`*os-clr-on-clr* <enable-user-space>`.
However, given how many packages this bundle contains, you may prefer
instead to deploy a leaner OS with only bundles relevant to your project.
Developer Workstation responds to this need.
Use Table 1 to identify the *minimum required bundles* you need to get
started developing based on your role. While your role may not
neatly fit into one of these categories, use Table 1 as a starting point.
Use Table 1, *Clear Linux Developer Profiles*, to identify the *minimum
required bundles* to get started developing based on your role or project.
While your role may not fit neatly into one of these categories, use Table 1
as a starting point.
.. list-table:: **Table 1. Clear Linux Developer Profiles**
:widths: 20, 20, 20, 20
@@ -6,15 +6,17 @@ Use swupd search to find a bundle
.. contents:: :local:
depth: 2
This illustration shows you how to use `swupd search` as a Developer. We
assume that you have a basic knowledge of:
This help document shows you how to use `swupd search` as a Developer.
* How :ref:`swupd <swupd-guide>` works
* How :ref:`swupd differs <swupd-about>` from *package managers* in other Linux\* distributions
Assumptions:
This document assumes your goal is to use :ref:`mixer` to build your own
Clear Linux* OS for Intel® Architecture for a specific use case. Our example
is intended to show by example how to search and add a bundle.
* Basic knowledge of using :ref:`swupd <swupd-guide>`
* Understanding how :ref:`swupd <swupd-about>` differs from
other Linux\* distributions
* You plan to use :ref:`mixer` to build your own |CLOSIA|for a specific
use case
This example illustrates how to search for and add a bundle.
Scenario 1: Data Science with Python
====================================
@@ -22,10 +24,11 @@ Scenario 1: Data Science with Python
We're developing a custom Clear Linux OS for data science with Python. We'll
develop our own mix, from which we'll create a release image. That image
will be distributed to data center (DC) clients across the United States
who need this data to determine DC workload balancing. We need to
create a tool to analyze energy consumption profiles based on population
statistics and consumption data, whose results are heat-maps showing where
and when energy consumption peaks in large metropolitan areas.
who need this data to determine DC workload balancing. Why? We need to
create a tool to analyze energy consumption based on population
statistics and consumption data. Our tool's custom dashboard will include
heat-maps showing where and when energy consumption peaks in large
metropolitan areas.
So far, we know we need Python data science capabilities.
@@ -57,7 +60,7 @@ First, use :command:`swupd search` with a general term like *Python*.
Result above is one of several shown in standard output.
If the bundle is already installed, [installed] appears in search results. If it doesn't apppear, the bundle needs to be installed.
If the bundle is already installed, *[installed]* appears in search results. If that doesn't apppear, the bundle needs to be installed.
#. Add the bundle `python-data-science`.