Commit Graph

25 Commits

Author SHA1 Message Date
9b90498b07 Trivial: Update pypi url to new url
Pypi url changed from [1] to [2]

[1] https://pypi.python.org/pypi/<package>
[2] https://pypi.org/project/<package>

Change-Id: Ic639298e83189410395f31cc9ef60076af479efd
2018-04-20 17:30:47 +07:00
05b2a14fe0 Update broken link
Change-Id: I8d13696970593d47d0f07cf97aa1284eed5f7a15
2018-01-23 14:57:18 +08:00
4ddd4c8a63 Update ubuntu version to be correct target
- saio describes both 14.04 and 16.04 procedure
- currently we're testing on 16.04 (xenial) envrionment on the gate

Remaining task (probably another work):
- review the installation guide which adjusts to the ubuntu 14.04 LTS

Change-Id: Id690a1deabeb24bfc1af3ba3a3019794fe4b8eb9
2017-09-12 02:21:41 +09:00
13a07aa77a Misc doc cleanup
* Change some absolute URLs to internal links
* Fix some bulletted list indentation
* Choose a better lexer for some syntax highlighting
* Use ``inline code`` instead of `italics` for some example command
  lines
* Change some quoted paragraphs that only included inlined code to be
  proper code blocks

Change-Id: Iaaa7eefb690122f5af9dcb1c871358c22335c743
2017-07-12 12:14:45 -07:00
92274d4790 List system dependencies for running common tests
Add an other-requirements.txt file containing a cross-platform list of
dependencies needed for running included tox-based tests. Also include a
tox environment for convenience calling the bindep[*] utility to list
any missing system requirements.

Document bindep and other-requirements usage.

This change is self-testing.

For other-requirements.txt see also
http://docs.openstack.org/infra/manual/drivers.html#package-requirements

[*] http://docs.openstack.org/infra/bindep/

Change-Id: Iea6f5fecba3b7cb9f6dac7029c0f17fc31fc0e3c
2016-05-12 08:51:31 +02:00
5a7383313b Swift documentation for first-time contributors.
In this change, there are proposed improvement to Swift documentation aimed at
first-time contributors. They include a simplification of the Getting
Started page and a new page with some basic instructions/commands that the
first-time contributor should know. In addition, it shows some common errors
that the first-time contributor may find when executing git rebase and
information on how to track your changes.

Change-Id: I704202955093736b2f3b4102a649690a0392c6b0
2015-07-29 21:40:28 -07:00
2d6c5fe2af Fix Associated Projects link on Getting Started
Change-Id: I50be656bc5868242489f97c96a1feaef171933e0
2015-07-21 09:57:54 -07:00
5374ba3a80 drop Python 2.6 testing support
Change-Id: I78f21e5794e8ba7a095f03d279247516a241f555
2015-05-27 12:28:04 -07:00
949804eda4 update the getting started doc
Change-Id: I0a96bcf692bb240f3ab5aab7fefd294a07735a83
2015-02-17 13:24:33 -08:00
dd3564a587 Mention Python 2.7 in Getting Started guide
Change-Id: I2992d1227f294d4cb1c6a8676137df44e231bd80
2014-10-24 15:34:45 -07:00
047215afeb Update Getting Started requirements versions
These docs currently say we target ubuntu 10.04 and an eventlet version
that our requirements file does not allow. Update these versions.

Change-Id: I052b6561f88ec90f865454e426032f1baf4586c0
2014-10-24 15:23:33 -07:00
39fc4c37bf Doc changes for new pip-requirements
dnspython was added recently to the list of requirments.

This patch completes the change:
1. The new requirement is documented
2. The need for tox --recreate is documented
(assuming there is no way to automate 2 above)

Change-Id: I49f0cb4b01b79dd7cf4329984a2f8416378ebe19
Fixes: Bug #1176627
2013-05-06 19:21:53 +03:00
bf90ba2de1 Remove outdated Debian packaging guide.
There are 3 sections in there, all useless.

Section 1 tells you how to install Swift packages from the swift-core
PPA. However, the latest version there is ancient.

Section 2 tells you how to build your own Swift packages. However, it
talks about getting the source code from the "debian" branch in bzr,
which is obviously really old.

Section 3 tells you how to take the packages from section 2 and
install them. This isn't too out-of-date, but since section 2 doesn't
work any more, section 3 is useless.

Since stale docs are worse than no docs, there's no current
information in this document, and bringing it up-to-date requires a
whole pile of work, I've chosen to delete it entirely.

Also pulled out a couple references to the PPA elsewhere.

Fixes bug 917385.
Fixes bug 1026145.

Change-Id: I510bd8619531fe110419e5488bd20d3602868d66
2012-11-13 13:06:48 -08:00
5e3e9a882d local WSGI Request and Response classes
This change replaces WebOb with a mostly compatible local library,
swift.common.swob.  Subtle changes to WebOb's API over the years have been a
huge headache.  Swift doesn't even run on the current version.

There are a few incompatibilities to simplify the implementation/interface:
 * It only implements the header properties we use.  More can be easily added.
 * Casts header values to str on assignment.
 * Response classes ("HTTPNotFound") are no longer subclasses, but partials
   on Response, so things like isinstance no longer work on them.
 * Unlike newer webob versions, will never return unicode objects.

Change-Id: I76617a0903ee2286b25a821b3c935c86ff95233f
2012-09-28 14:48:48 -07:00
56645b9cb1 Updates swift docs to use correct release PPA.
Changes swift doc references from defunct ppa repo swift-core/ppa to
new swift-core/release repo.  Fixes lp bug 905608.

Change-Id: I58d85b22d8dbcff43b03eb256ad39e03dd208bfc
2011-12-16 20:22:18 -08:00
c9728e7868 Change bzr to swift in getting_started doc.
Fixes #884766.

Change-Id: Id251fa04305352522db22cd27410f0b2e6e9fc06
2011-11-07 17:27:18 +01:00
72bc89c453 Add a "getting swift" section to the getting started doc 2011-03-01 15:24:15 +00:00
e2c0a23839 Added doc strings and pointers to docs for swift3 2011-01-14 13:49:05 -06:00
9dc5ffcd07 Adds multi server install doc 2010-11-04 14:25:23 -05:00
f9bd31b6ba fixed typo 2010-11-04 09:53:02 -05:00
a6ccc44f89 Updated SAIO to point to RHEL instructions on wiki 2010-10-28 17:01:50 -05:00
39a9394751 Modified for edits.
-------------This line and the following will be ignored --------------


modified:
  doc/source/development_auth.rst
  doc/source/getting_started.rst
2010-10-14 13:11:21 -05:00
fe03bebcb0 Corrects a typo in the Getting Started page 2010-09-21 10:56:41 -05:00
3657c08cd3 another typo 2010-07-20 11:17:36 -05:00
99f022aae0 Added getting started documentation and architectural overview 2010-07-20 11:05:10 -05:00