Skip to content

Commit

Permalink
Apply pyspellchecking and fixes
Browse files Browse the repository at this point in the history
  • Loading branch information
jugmac00 committed Oct 14, 2023
1 parent b3b314b commit 9ea36dc
Show file tree
Hide file tree
Showing 8 changed files with 270 additions and 27 deletions.
239 changes: 239 additions & 0 deletions .custom_wordlist.txt
Original file line number Diff line number Diff line change
@@ -1 +1,240 @@
adapter
adapter's
analyze
analyzer
AppleApplications
appmanifest
appserver
appservers
artifact
artifacts
attrgetter
auditable
auth
authorization
authorized
authorizes
autocert
backend
backends
Blazingly
bool
boolean
breakpoint
browserconfig
buildbot
buildd
bzr
bzr's
cgroup
cgroups
charmcraft
CMDLINE
codebase
Codehosting
codeimport
codeimportscheduler
config
configs
ConfiguringWebApplications
cron
cronjobs
crontabs
cryptographic
cryptographically
customize
CVE
DatabaseSetup
ddl
defense
defense
deps
dev
directDelivery
DirectDelivery
distutils
DNS
docstring
Docstring
docstrings
Docstrings
doctest
doctests
docutils
dogfood
dtrt
el
epydoc
executables
facetted
favicons
formlib
FreshLogs
frontend
frontends
globals
gunicorn
gzip
hostnames
HSTS
html
http
https
https
iharness
IMailDelivery
IMailer
infos
initialized
integrations
ip
IPv
IPython
jenkaas
jenkins
jinja
lazr
lifecycle
logrotate
lookup
lookups
LOSAs
lp
lpci
lpnet
LTS
lxc
lxd
LXD's
macOS
matchers
maximize
mbox
mboxMailer
memcache
minimize
mojo
mozilla
OAuth
ols
OpenID
opstats
optimization
optimize
optimizing
optstats
organize
orm
OWASP
OWASP's
pagespeed
PageSpeed
pentested
performant
pgsql
pgSQL
pipx
plaintext
pooler
PostgreSQL
PostGreSQL
PPA
PQM
pre
preprocessed
prioritize
prometheus
py
pydoctor
PyPI
qastaging
queueddelivery
queuedDelivery
QueuedDelivery
quickref
quickstart
rctp
realfavicongenerator
repo
rocketfuel
rollout
rollouts
RPC
rst
rsync
runtime
SafariWebContent
sdist
sendmail
SendmailMailer
setuptools
simplestreams
Slony
smtp
smtpMailer
SMTPMailer
snapshotting
sourcecode
sourceforge
sourcetree
soyuz
specialized
specializes
SQLObject
SRE
SREs
SSO
standardized
stdin
stg
stubmailer
stubMailer
subdirectory
subprocess
sudo
summarized
svg
symlinked
syntax
syntaxes
systemd
talisker
templating
testability
testbed
testMailer
TestMailer
testrunner
testrunner's
testtools
TLS
tradeoff
tradeoffs
Transactional
tsearch
ubuntu
Ubuntu
UCT
UltimateVimPythonSetup
untrusted
vbuilder
virtualenv
virtualenvs
VPN
webhook
webservice
webservice's
whitespace
worktrees
WSGI
www
xml
XML-RPC
xmlrpc
YAGNI
yaml
zcml
ZFS
zope
Zope
Zope's
4 changes: 2 additions & 2 deletions explanation/charms.rst
Original file line number Diff line number Diff line change
Expand Up @@ -60,9 +60,9 @@ configuration as well as code, and can help to avoid gratuitous differences
between deployments. `Jinja <https://jinja.palletsprojects.com/>`_
templates are widely used in both charms and Mojo specs as part of this.

Keep multi-datacentre operation in mind where possible. We don't have
Keep multi-data centre operation in mind where possible. We don't have
enough experience with this yet to know what we'll need to do, but it's
likely to involve deploying parts of an application in different datacentres
likely to involve deploying parts of an application in different data centres
from other parts, so loose coupling will help: for example, it may be useful
to allow configuring connections using explicit configuration as well as or
instead of Juju integrations.
Expand Down
12 changes: 5 additions & 7 deletions explanation/codeimport.rst
Original file line number Diff line number Diff line change
Expand Up @@ -24,12 +24,11 @@ per-import basis, that's actually not exposed right now.

The frequency depends on the type of the revision control system, and is set in
``effective_update_interval``,
see https://git.launchpad.net/launchpad/tree/lib/lp/code/model/codeimport.py.
see `the codeimport module <https://git.launchpad.net/launchpad/tree/lib/lp/code/model/codeimport.py>`_.

As the default intervals in the config schema aren't overridden anywhere right
now, you can look them up in the ``codeimport`` section in the configuration
schema:
https://git.launchpad.net/launchpad/tree/lib/lp/services/config/schema-lazr.conf.
now, you can look them up in the ``codeimport`` section in the `configuration
schema <https://git.launchpad.net/launchpad/tree/lib/lp/services/config/schema-lazr.conf>`_.

Trigger code import
===================
Expand All @@ -52,10 +51,9 @@ in time, as the process works like this:

- cronjobs in ``lp-codeimport`` run workers
- when the code import worker is looking for work to do, it calls
``getJobForMachine``,
see https://git.launchpad.net/launchpad/tree/lib/lp/code/xmlrpc/codeimportscheduler.py
``getJobForMachine`` in the `codeimportscheduler module <https://git.launchpad.net/launchpad/tree/lib/lp/code/xmlrpc/codeimportscheduler.py>_`
- that calls ``getJobForMachine``
in https://git.launchpad.net/launchpad/tree/lib/lp/code/model/codeimportjob.py
in the `codeimport module <https://git.launchpad.net/launchpad/tree/lib/lp/code/model/codeimportjob.py>`_
which makes a DB query to fetch the first job from a table that has
``due_date`` not in the future, and that is marked as ``pending``
- it then triggers the import
Expand Down
6 changes: 3 additions & 3 deletions explanation/favicon.rst
Original file line number Diff line number Diff line change
Expand Up @@ -9,9 +9,9 @@ These files were generated from a single SVG file containing the logo (``lib/can
* ``android-chrome-192x192.png`` - Used as the icon when the web application is added to the Android home screen.
* ``android-chrome-512x512.png`` - Used to show a splash screen when the web application is being loaded. See https://web.dev/add-manifest/#splash-screen.
* ``apple-touch-icon.png`` - Used by iOS when the web application is added to the iOS home screen. See https://developer.apple.com/library/archive/documentation/AppleApplications/Reference/SafariWebContent/ConfiguringWebApplications/ConfiguringWebApplications.html.
* ``safari-pinned-tab.svg`` - Used as the icon when the tab with the web application opened is pinned. See https://developer.apple.com/library/archive/documentation/AppleApplications/Reference/SafariWebContent/pinnedTabs/pinnedTabs.html.
* ``browserconfig.xml`` - Used by Windows to specify the tiles for pinned sites. See https://docs.microsoft.com/en-us/previous-versions/windows/internet-explorer/ie-developer/platform-apis/dn320426(v=vs.85).
* `safari-pinned-tab.svg <https://developer.apple.com/library/archive/documentation/AppleApplications/Reference/SafariWebContent/pinnedTabs/pinnedTabs.html>`_ - Used as the icon when the tab with the web application opened is pinned.
* `browserconfig.xml <https://docs.microsoft.com/en-us/previous-versions/windows/internet-explorer/ie-developer/platform-apis/dn320426(v=vs.85)>`_ - Used by Windows to specify the tiles for pinned sites.
* ``mstile-*.png`` - Used by the tiles of various sizes on Windows 8 and newer versions of Windows.
* ``site.webmanifest`` - The web app manifest is a JSON file that tells the browser about your Progressive Web App and how it should behave when installed on the user's desktop or mobile device. A typical manifest file includes the app name, the icons the app should use, and the URL that should be opened when the app is launched. See https://www.w3.org/TR/appmanifest/ and https://developer.mozilla.org/en-US/docs/Web/Manifest.

For more details, see https://archive.ph/CAqQm.
For more details, see the `FAQ of the code realfavicongenerator site <https://archive.ph/CAqQm>`_.
21 changes: 15 additions & 6 deletions explanation/pip.rst
Original file line number Diff line number Diff line change
@@ -1,15 +1,14 @@
Launchpad pip integration
*************************

Launchpad uses the pip_ build system for managing Python packages (replacing
`zc.buildout`, which we used for many years).
Launchpad uses the pip_ build system for managing Python packages.

We have at least two other ways of managing dependencies. Apt
manages our Python language installation, as well as many of our
non-Python system-level dependencies, such as PostgreSQL. The
sourcecode directory is our other way of managing dependencies. It is
supposed to only contain dependencies that are not standard Python
packages. bzr plugins and Javascript libraries are existing examples.
packages. bzr plugins and JavaScript libraries are existing examples.

All developers will at least want to read the very brief sections about the
`Set Up`_ and the `Everyday Usage`_.
Expand Down Expand Up @@ -202,12 +201,16 @@ Let's suppose that we want to add the "lazr.foo" package as a dependency.
error-prone to fetch the desired package from PyPI along with any new
dependencies it may have.

3. Run the following command (or your variation)::
3. Run the following command (or your variation):

.. code-block:: shell
bin/pip install --no-binary :all: lazr.foo
This will either produce some errors which you'll need to fix, or it
will succeed and finish with a line such as this::
will succeed and finish with a line such as this:

.. code-block:: shell
Successfully installed lazr-foo-1.1.2 z3c.shazam-2.0.1 zope.bar-3.6.1
Expand All @@ -220,6 +223,8 @@ Let's suppose that we want to add the "lazr.foo" package as a dependency.
4. Add the successfully-installed packages to the shared download cache for
future use.

.. code-block:: shell
bin/pip download -d download-cache/dist/ --no-deps \
--no-binary :all: ...
Expand All @@ -228,6 +233,8 @@ Let's suppose that we want to add the "lazr.foo" package as a dependency.
version number with ``==`` to turn each package/version pair into a
requirements specifier. So, in the case above, you would run:

.. code-block:: shell
bin/pip download -d download-cache/dist/ --no-deps \
--no-binary :all: \
lazr-foo==1.1.2 z3c.shazam==2.0.1 zope.bar==3.6.1
Expand All @@ -242,7 +249,9 @@ Let's suppose that we want to add the "lazr.foo" package as a dependency.
liable to download too much otherwise.

5. Add the new versions to ``requirements/launchpad.txt``, still using the
requirements specifier syntax::
requirements specifier syntax:

.. code-block:: shell
lazr.foo==1.1.2
z3c.shazam==2.0.1
Expand Down
5 changes: 1 addition & 4 deletions how-to/checking-availability-of-launchpad-frontends.rst
Original file line number Diff line number Diff line change
Expand Up @@ -30,7 +30,4 @@ Check individual frontend
$ curl --resolve launchpad.net:443:185.125.189.222 https://launchpad.net/
Further information
===================

https://everything.curl.dev/usingcurl/connections/name#provide-a-custom-ip-address-for-a-name
More infos on `using curl <https://everything.curl.dev/usingcurl/connections/name#provide-a-custom-ip-address-for-a-name>`_.
2 changes: 1 addition & 1 deletion reference/services/build-farm.rst
Original file line number Diff line number Diff line change
Expand Up @@ -84,7 +84,7 @@ Related specifications

Log files
---------
See https://wiki.canonical.com/Launchpad/FreshLogs.
See `https://wiki.canonical.com/Launchpad/FreshLogs <https://wiki.canonical.com/Launchpad/FreshLogs>`_.

Production
~~~~~~~~~~
Expand Down
Loading

0 comments on commit 9ea36dc

Please sign in to comment.