-
Notifications
You must be signed in to change notification settings - Fork 11
Serve web version of the book
License
SystemsApproach/SystemsApproach.github.io
Folders and files
| Name | Name | Last commit message | Last commit date | |
|---|---|---|---|---|
Repository files navigation
<!DOCTYPE html>
<!--[if IE 8]><html class="no-js lt-ie9" lang="en" > <![endif]-->
<!--[if gt IE 8]><!--> <html class="no-js" lang="en" > <!--<![endif]-->
<head>
<meta charset="utf-8">
<meta name="viewport" content="width=device-width, initial-scale=1.0">
<title>About This Book — Computer Networks: A Systems Approach Version 6.2-dev documentation</title>
<link rel="shortcut icon" href="static/bridge.ico"/>
<script type="text/javascript" src="static/js/modernizr.min.js"></script>
<script type="text/javascript" id="documentation_options" data-url_root="./" src="static/documentation_options.js"></script>
<script type="text/javascript" src="static/jquery.js"></script>
<script type="text/javascript" src="static/underscore.js"></script>
<script type="text/javascript" src="static/doctools.js"></script>
<script type="text/javascript" src="static/language_data.js"></script>
<script async="async" type="text/javascript" src="https://cdnjs.cloudflare.com/ajax/libs/mathjax/2.7.5/latest.js?config=TeX-AMS-MML_HTMLorMML"></script>
<script type="text/javascript" src="static/js/theme.js"></script>
<link rel="stylesheet" href="static/css/theme.css" type="text/css" />
<link rel="stylesheet" href="static/pygments.css" type="text/css" />
<link rel="stylesheet" href="static/css/rtd_theme_mods.css" type="text/css" />
<link rel="index" title="Index" href="genindex.html" />
<link rel="search" title="Search" href="search.html" />
<link rel="prev" title="Emerging Topics" href="supplements.html" />
</head>
<body class="wy-body-for-nav">
<div class="wy-grid-for-nav">
<nav data-toggle="wy-nav-shift" class="wy-nav-side">
<div class="wy-side-scroll">
<div class="wy-side-nav-search" >
<a href="index.html" class="icon icon-home"> Computer Networks: A Systems Approach
</a>
<div class="version">
Version 6.2-dev
</div>
<div role="search">
<form id="rtd-search-form" class="wy-form" action="search.html" method="get">
<input type="text" name="q" placeholder="Search docs" />
<input type="hidden" name="check_keywords" value="yes" />
<input type="hidden" name="area" value="default" />
</form>
</div>
</div>
<div class="wy-menu wy-menu-vertical" data-spy="affix" role="navigation" aria-label="main navigation">
<p class="caption"><span class="caption-text">Table of Contents</span></p>
<ul class="current">
<li class="toctree-l1"><a class="reference internal" href="preface.html">Preface</a></li>
<li class="toctree-l1"><a class="reference internal" href="foundation.html">Chapter 1: Foundation</a></li>
<li class="toctree-l1"><a class="reference internal" href="direct.html">Chapter 2: Direct Links</a></li>
<li class="toctree-l1"><a class="reference internal" href="internetworking.html">Chapter 3: Internetworking</a></li>
<li class="toctree-l1"><a class="reference internal" href="scaling.html">Chapter 4: Advanced Internetworking</a></li>
<li class="toctree-l1"><a class="reference internal" href="e2e.html">Chapter 5: End-to-End Protocols</a></li>
<li class="toctree-l1"><a class="reference internal" href="congestion.html">Chapter 6: Congestion Control</a></li>
<li class="toctree-l1"><a class="reference internal" href="data.html">Chapter 7: End-to-End Data</a></li>
<li class="toctree-l1"><a class="reference internal" href="security.html">Chapter 8: Network Security</a></li>
<li class="toctree-l1"><a class="reference internal" href="applications.html">Chapter 9: Applications</a></li>
<li class="toctree-l1"><a class="reference internal" href="supplements.html">Emerging Topics</a></li>
<li class="toctree-l1 current"><a class="current reference internal" href="#">About This Book</a><ul>
<li class="toctree-l2"><a class="reference internal" href="#read-the-book">Read the Book</a></li>
<li class="toctree-l2"><a class="reference internal" href="#releases-and-editions">Releases and Editions</a></li>
<li class="toctree-l2"><a class="reference internal" href="#build-the-book">Build the Book</a></li>
<li class="toctree-l2"><a class="reference internal" href="#how-to-contribute">How to Contribute</a></li>
<li class="toctree-l2"><a class="reference internal" href="#join-us">Join Us</a></li>
</ul>
</li>
</ul>
</div>
</div>
</nav>
<section data-toggle="wy-nav-shift" class="wy-nav-content-wrap">
<nav class="wy-nav-top" aria-label="top navigation">
<i data-toggle="wy-nav-top" class="fa fa-bars"></i>
<a href="index.html">Computer Networks: A Systems Approach</a>
</nav>
<div class="wy-nav-content">
<div class="rst-content">
<div role="navigation" aria-label="breadcrumbs navigation">
<ul class="wy-breadcrumbs">
<li><a href="index.html">Docs</a> »</li>
<li>About This Book</li>
<li class="wy-breadcrumbs-aside">
<a href="_sources/README.rst.txt" rel="nofollow"> View page source</a>
</li>
</ul>
<hr/>
</div>
<div role="main" class="document" itemscope="itemscope" itemtype="http://schema.org/Article">
<div itemprop="articleBody">
<div class="section" id="about-this-book">
<h1>About This Book<a class="headerlink" href="#about-this-book" title="Permalink to this headline">¶</a></h1>
<p>This <a class="reference external" href="https://github.com/SystemsApproach">site</a>
contains source text for <em>Computer Networks: A Systems
Approach</em>, now available under terms of the <a class="reference external" href="https://creativecommons.org/licenses/by/4.0">Creative Commons (CC BY
4.0)</a> license. The
community is invited to contribute corrections, improvements, updates,
and new material under the same terms.</p>
<p>Like many open source software projects, this one has been seeded with
once restricted content: the 5th edition of <em>Peterson and Davie</em>,
copyrighted by Elsevier. Our hope is that open sourcing this material
will both make it widely available and serve as an attractor for new
content: updating what’s already there, expanding it to cover new
topics, and augmenting the text with additional teaching collateral.</p>
<p>We will initially play an editorial role (curating and wordsmithing) for
contributions that come back, but our plan is to share ownership of the
project with others committed to its success.</p>
<p>And if you make use of this work, the attribution should include the
following information:</p>
<div class="line-block">
<div class="line">Title: <em>Computer Networks: A Systems Approach</em></div>
<div class="line">Authors: Larry Peterson and Bruce Davie</div>
<div class="line">Copyright: Elsevier, 2012</div>
<div class="line">Source: <a class="reference external" href="https://github.com/SystemsApproach">https://github.com/SystemsApproach</a></div>
<div class="line">License: <a class="reference external" href="https://creativecommons.org/licenses/by/4.0">CC BY 4.0</a></div>
</div>
<div class="section" id="read-the-book">
<h2>Read the Book<a class="headerlink" href="#read-the-book" title="Permalink to this headline">¶</a></h2>
<p>This book is part of the <a class="reference external" href="https://www.systemsapproach.org">Systems Approach Series</a>, with an online version published
at <a class="reference external" href="https://book.systemsapproach.org">https://book.systemsapproach.org</a>.</p>
<p>To track progress and receive notices about new versions, you can follow
the project on
<a class="reference external" href="https://www.facebook.com/Computer-Networks-A-Systems-Approach-110933578952503/">Facebook</a>
and <a class="reference external" href="https://twitter.com/SystemsAppr">Twitter</a>. To read a running
commentary on how the Internet is evolving, follow the <a class="reference external" href="https://www.systemsapproach.org/blog">Systems Approach
Blog</a>.</p>
</div>
<div class="section" id="releases-and-editions">
<h2>Releases and Editions<a class="headerlink" href="#releases-and-editions" title="Permalink to this headline">¶</a></h2>
<p>We release ever-changing open source content rather than publish fixed
books, although you can roughly equate v6.0 with a 6th Edition. Read the
<a class="reference external" href="preface.html">Preface</a> to find out what’s new in this version. Note
that Morgan Kaufmann (Elsevier) plans to publish a 6th edition of their
textbook based on a fork of v6.0, but going forward, open source
releases found here will not necessarily stay in sync with any future
published editions.</p>
<p>In general, <code class="docutils literal notranslate"><span class="pre">master</span></code> contains a coherent and internally consistent
version of the material. (If it were code, the book would build and
run.) New content under development is checked into branches until it
can be merged into <code class="docutils literal notranslate"><span class="pre">master</span></code> without breaking self-consistency. The web
version of the book available at <a class="reference external" href="https://book.systemsapproach.org">https://book.systemsapproach.org</a> is
periodically generated from <code class="docutils literal notranslate"><span class="pre">master</span></code>, and corresponds to a typical
maintenance release, although we do not bother to tag it as such (e.g.,
6.0.1).</p>
<p>Minor releases (e.g., v6.1) are tagged whenever there is sufficient new
content to justify the effort. This happens quarterly, give-or-take, and
is primarily to create a snapshot so that everyone in a course can know
they are using the same version. The off-line formats (e.g., pdf, epub)
are also generated with every minor release.</p>
</div>
<div class="section" id="build-the-book">
<h2>Build the Book<a class="headerlink" href="#build-the-book" title="Permalink to this headline">¶</a></h2>
<p>The source content is organized as a git repository per chapter, each of
which focuses on a major networking topic (e.g., <em>Internetworking</em>,
<em>Congestion Control</em>). A “root” repo (<a class="reference external" href="https://github.com/SystemsApproach/book">this
one</a>) contains the
top-level files needed to assemble a full book.</p>
<p>To build a web-viewable version, you first need to download the source:</p>
<div class="code shell highlight-default notranslate"><div class="highlight"><pre><span></span><span class="n">mkdir</span> <span class="o">~/</span><span class="n">systemsapproach</span>
<span class="n">cd</span> <span class="o">~/</span><span class="n">systemsapproach</span>
<span class="n">git</span> <span class="n">clone</span> <span class="n">https</span><span class="p">:</span><span class="o">//</span><span class="n">github</span><span class="o">.</span><span class="n">com</span><span class="o">/</span><span class="n">systemsapproach</span><span class="o">/</span><span class="n">book</span><span class="o">.</span><span class="n">git</span>
<span class="n">cd</span> <span class="n">book</span>
<span class="n">git</span> <span class="n">submodule</span> <span class="n">init</span>
<span class="n">git</span> <span class="n">submodule</span> <span class="n">update</span>
</pre></div>
</div>
<p>The build process is stored in the <code class="docutils literal notranslate"><span class="pre">Makefile</span></code> and requires Python be
installed. The <code class="docutils literal notranslate"><span class="pre">Makefile</span></code> will create a virtualenv (<code class="docutils literal notranslate"><span class="pre">doc_venv</span></code>) which
installs the documentation generation toolset.</p>
<p>To generate HTML in <code class="docutils literal notranslate"><span class="pre">_build/html</span></code>, run <code class="docutils literal notranslate"><span class="pre">make</span> <span class="pre">html</span></code>.</p>
<p>To get a live reload in your browser (refreshes on file save), run <code class="docutils literal notranslate"><span class="pre">make</span> <span class="pre">reload</span></code>.</p>
<p>To check the formatting of the book, run <code class="docutils literal notranslate"><span class="pre">make</span> <span class="pre">lint</span></code>.</p>
<p>To see the other available output formats, run <code class="docutils literal notranslate"><span class="pre">make</span></code>.</p>
</div>
<div class="section" id="how-to-contribute">
<h2>How to Contribute<a class="headerlink" href="#how-to-contribute" title="Permalink to this headline">¶</a></h2>
<p>We hope that if you use this material, you are also willing to
contribute back to it. If you are new to open source, you might check
out this <a class="reference external" href="https://opensource.guide/how-to-contribute/">How to Contribute to Open
Source</a> guide. Among
other things, you’ll learn about posting <em>Issues</em> that you’d like to see
addressed, and issuing <em>Pull Requests</em> to merge your improvements back
into GitHub.</p>
<p>If you do want to contribute either patches or new material, you will
need to sign a <a class="reference external" href="https://github.com/SystemsApproach/book/blob/master/CLA.md">Contributor Licensing Agreement
(CLA)</a>.
You’ll be prompted to sign the CLA the first time you make a pull
request.</p>
<p>The CLA is pretty straightforward: it establishes that (a) you have the
right to contribute what you’re contributing, and (b) what you
contribute is available to everyone else under the same <a class="reference external" href="https://creativecommons.org/licenses/by/4.0">CC
BY</a> terms as the
existing content. The CLA is a little unusual in that it explicitly
calls out Elsevier’s rights (which are the same as everyone’s), but this
does signal their intent to continue publishing textbooks based on the
material.</p>
<p>You should also familiarize yourself with the <a class="reference external" href="https://github.com/SystemsApproach/book/blob/master/CONTRIBUTING.rst">guidelines for
contributing</a>.</p>
<p>If you’d like to contribute and are looking for something that needs
attention, see the current <a class="reference external" href="https://github.com/orgs/SystemsApproach/projects/">Project
Board</a>. We’d also
like to expand the set of topics/chapters beyond the initial set
inherited from the 5th edition, so if you have ideas, we’d love to hear
from you. Send email to <code class="docutils literal notranslate"><span class="pre">discuss@systemsapproach.org</span></code>, or better yet,
<a class="reference external" href="https://groups.google.com/a/systemsapproach.org/forum/#!forum/discuss">join the
forum</a>.</p>
<p>Finally, in as much as this is an on-going effort, we will try to record
and track our
<a class="reference external" href="https://github.com/SystemsApproach/book/blob/master/status.rst">progress</a>.
For now, think of this as a poor-man’s release notes. Additional
information about work-in-progress can be found in the
<a class="reference external" href="https://github.com/SystemsApproach/book/wiki">wiki</a>.</p>
</div>
<div class="section" id="join-us">
<h2>Join Us<a class="headerlink" href="#join-us" title="Permalink to this headline">¶</a></h2>
<p>We hope you’ve gotten value out of <em>Computer Networks: A Systems
Approach</em> over the years, and we’re eager to have you join us in this
new venture.</p>
<div class="line-block">
<div class="line">Larry Peterson & Bruce Davie</div>
<div class="line">November 2019</div>
</div>
</div>
</div>
</div>
</div>
<footer>
<div class="rst-footer-buttons" role="navigation" aria-label="footer navigation">
<a href="supplements.html" class="btn btn-neutral float-left" title="Emerging Topics" accesskey="p" rel="prev"><span class="fa fa-arrow-circle-left"></span> Previous</a>
</div>
<hr/>
<div role="contentinfo">
<p>
© Copyright 2019
</p>
</div>
Built with <a href="http://sphinx-doc.org/">Sphinx</a> using a <a href="https://github.com/rtfd/sphinx_rtd_theme">theme</a> provided by <a href="https://readthedocs.org">Read the Docs</a>.
</footer>
</div>
</div>
</section>
</div>
<script type="text/javascript">
jQuery(function () {
SphinxRtdTheme.Navigation.enable(true);
});
</script>
</body>
</html>
About
Serve web version of the book
Resources
License
Stars
Watchers
Forks
Releases
No releases published
Packages 0
No packages published