31 Commits

Author SHA1 Message Date
Richard Jones
251bdee2ca Internet Explorer minimum version raised to 11+
Update the doc to raise the minimum supported version from 9 to 11.

Change-Id: I2e605aa287dea5acc6ac72a9971d56e3076a7054
Closes-Bug: 1531301
2016-01-06 08:29:03 +11:00
Travis Tripp
07fd6d83e2 Improve release notes guidance - single patch
After some discussion on a patch and in room with Doug,
we determined that we should make the guidance for release notes
more strongly suggest providing release notes in the same
patch as the changes being introduced.

Change-Id: Ifa8e8e9b01fafaa0a7e3e12b0052e4f8d5554e58
2015-11-30 11:31:33 -07:00
Jenkins
33af6ffbee Merge "Document how to generate docs using tox" 2015-11-19 03:39:01 +00:00
lin-hua-cheng
dec8e2580d Document release notes process
Since we added support for reno, document that submitters should
provide release notes with their changes. Rather than expecting
others to provide them at the end.

Change-Id: I787f37c9a748774b01cea08da38d91d62de96dd1
2015-11-16 19:13:08 -08:00
lin-hua-cheng
fb07cc1b80 Document how to generate docs using tox
Change-Id: I7c3b32a2dc4c0f98191ff9aa49f7f6b3e5ae69c7
2015-11-16 19:08:37 -08:00
Akihiro Motoki
c2442231d5 Retire the reference of StackForge
Change-Id: I6f71c55e24047013d6ed5903ba1af612002ad841
2015-11-11 03:23:05 +09:00
Rob Cresswell
88a02211ce Update Contributing doc & cleanup
Small changes to the Contributing documentation, and style cleanup

Change-Id: Idbfb913b225f40df45ffec0589721a79070dae9a
Closes-Bug: 1491469
2015-09-02 21:08:27 +01:00
David Lyle
6fbb70ebf2 Fixing .rst file issues
Correcting errors in rst file formatting.

Partial-Bug: #1486222
Change-Id: Id0a703d42609165a17ca84dade94b2c04894e208
2015-08-18 20:15:40 +00:00
Michael Krotscheck
c6c0352982 Switched from JSCS to ESLint
This patch switches horizon from using JSCS to using ESlint. It
adds the john papa style guides as an eslint plugin, and deactivates
additional linting rules so current cleanup efforts can focus on the
issues remaining from JSCS. Once that cleanup effort is complete,
we can switch our linting job to voting and move forward from there.

YAML for .eslintrc was chosen because the JSON specification does
not allow comments, and having comments (including rule links) will
make it easier to discuss linting changes.

Deactivated eslint rules have each been annotated with a # TODO
statement, so we can address them in the future. Links in the
documentation have been updated to new contributor guidelines, which
will be updated after this patch lands.

Linting may be executed by first installing npm dependencies using
`npm install`, and then executing `npm run lint` at any time in the
future. No python venv is required.

For clarification: We are switching to ESLint because JSCS explicitly
focuses on code-style, not on language use errors. For that purpose,
JSCS explicitly defers to JSHint, which due to the 'do no evil' license is
not usable. Since ESLint provides both the codestyle functionality, and
the language use checks, of both JSCS and JSHint, it was deemed the
only viable tool,

http://lists.openstack.org/pipermail/openstack-dev/2015-June/067030.html

Change-Id: Ib4c3f77f8cc3cdaa3c7558b7bc3a6d1299b6dcbe
Partially-Implements: blueprint jscs-cleanup
2015-06-30 23:00:29 -07:00
Rob Cresswell
8d2792f19f AngularJS in Horizon Documentation
This patch is a first pass at reducing the levels of "tribal knowledge"
and making the AngularJS codebase more accessible. It details code
style, file structures, testing and translation.

Change-Id: I22e6e5627216739fc92a5c9a5b417c6c6b16476d
Closes-Bug: 1373310
2015-06-29 13:23:55 +01:00
Thai Tran
c16b271a2b Small fix to angular docs
Removing outdated docs since we are now adopting JP's style guide.

Change-Id: I6766027addeaaa04756a478d07dc37fd4307907f
Closes-bug: #1458938
2015-05-26 20:45:25 +00:00
Tyr Johanson
660d43badf ngReorg - Align constants, factories and services
This commit makes injectable names consistent to include
the module as a prefix. This reduces confusiong about
exactly which item is being injected.

It also simplifies the naming scheme for the Angular-based
API modules.

This is one step in a larger effort to restructure the Angular
source. See https://review.openstack.org/#/c/176152/ for the
full set of planned changes.

Change-Id: I87d4ff78b97950248442056ce3ce5af9177042ae
Partial-Bug: #1454880
2015-05-21 21:14:57 +00:00
Tyr Johanson
2b7b8ac93c ngReorg - align module names with directory
This commit aligns module names with their directory
structure.

This is one step in a larger effort to restructure the Angular
source. See https://review.openstack.org/#/c/176152/ for the
full set of planned changes.

Change-Id: I3f48ebaef23d6249983f33b1a4710cc1fe3ef789
Partial-Bug: #1454880
2015-05-21 21:14:40 +00:00
Travis Tripp
7aa7f1b59d Adopt the John Papa Style Guide for AngularJS
This patch adds documentation recomending the John Papa Style guide.
Other patches may add automated style checks to JSCS.

Change-Id: Iae2cec88d8ea3c4ad570e1a1a42c5046bfef0dec
Implements: blueprint john-papa-style-guide
2015-05-09 16:32:14 -07:00
Radomir Dopieralski
358e65624c Update instruction for publishing xstatic packages
We want all our xstatic packages to be automatically published to PyPi
by Jenkins, not manually by individual packagers, if possible.

Also add a warning about the releases being permanent.

Change-Id: Ia800ac2bce5461a5051440f1a141de0d8cfeea8b
2015-03-31 15:40:36 +02:00
Matt Farina
52f401457f Updates contribution guidelines for JS object performance
In a new section, titled performance, a requirement is added
for JavaScript code to limit the re-creation of objects in
the same scope. An example with jQuery is given with explanation.

Change-Id: I2f0d8392277f65384389d8d20154d645197050af
Partial-Bug: #1412971
2015-01-29 12:51:27 -05:00
Jenkins
a38b728136 Merge "Pseudo translation tool" 2015-01-21 18:20:20 +00:00
Jenkins
d027413351 Merge "Fix grammatical mistake in contributing.rst doc" 2015-01-20 22:32:55 +00:00
Doug Fish
faae8b86fa Pseudo translation tool
A tool to allow pseudo translations to be created in order to identify
potential translation problems. To use the tool:
Make sure your English file is up to date:
./run_tests.sh --makemessages

Run the pseudo tool to create pseudo translations:
./run_tests.sh --pseudo de

Compile the catalog:
./run_tests.sh --compilemessages

Run your dev server. Log in and change to the language you pseudo translated.
It should look weird. More specifically, every translatable string is going
to start and end with a bracket and they are going to have some added
characters. For example, "Log In" will become "[~Log In~您好яшçあ]"
This is useful because you can inspect for the following:
- If you see a string in English it's not translatable. Should it be?
- If you see brackets next to each other that might be concatenation.
- If there is unexpected wrapping/truncation there might not be enough
  space for translations
- If you see a string in the proper translated language, it comes from an
  external source. (That's not bad, just sometimes useful to know)
- If you get new crashes, there is probably a bug. :-)

Implements blueprint: pseudo-translation-tool

Change-Id: If97754c2d4234b12b3d73616ff60527f6ad82d55
2015-01-20 13:08:26 -06:00
imran
0ede27a4de Fix grammatical mistake in contributing.rst doc
There is an extra 'that' in contributing.rst, which doesn't make
sense for the complete sentence. It should be omitted or written
in a different way as proposed in the bug description.

Change-Id: I4757c7948d0ee2701e985ee069ee6b2c5b9e769c
Closes-Bug: #1412617
2015-01-20 18:26:32 +00:00
Aaron Sahlin
272314fdee Update AngularJS best practices for translatable string
Added documentation for internationalization of text in JavaScript files.

Change-Id: I53a3d6da946cb2e10bf7155f66b65af6359751cb
2015-01-19 13:50:49 -06:00
Liz Blanchard
f38cd84ef3 Updating Horizon contributing docs
Updating Horizon contributing docs to include User Experience
and Persona Working Group details.

Change-Id: I6f19372b419f882f7d0d6485b90ad165df25fd2c
2015-01-14 18:38:42 +00:00
Jeremy Stanley
f85c0bff32 Workflow documentation is now in infra-manual
Replace URLs for workflow documentation to appropriate parts of the
OpenStack Project Infrastructure Manual.

Change-Id: Ibf8fb2f6a1e8b0f80db6ab1180894c235046e785
2014-12-05 03:30:36 +00:00
Aaron Sahlin
0c8bde6570 Update JavaScript best practices
Horizon as a project needs some best practices in place for client side
coding

Change-Id: I1361a9b203f2bb9c2f6a65e60f940aaff43935dd
2014-10-20 11:12:46 -05:00
Joanna H. Huang
5f0d35e994 Modified docs to list supported browsers
As reported in the bug, the documentation needs to be updated with
a list of browsers we support. This patch adds faq entry and updates
information for contributing.

Change-Id: I6218194d031bc6b47a0fd13e5e11749df441398b
Closes-Bug: 1359246
2014-09-11 00:29:15 +00:00
Radomir Dopieralski
3fb3cbdc45 Add instructions for packaging JS libs
Since we are going to use xstatic, it's nice to know how to add
new libraries to Horizon.

Change-Id: I04ecfe70c3b5715cf45d97c87113cdd7f53a0435
2014-08-22 13:18:33 +02:00
Jenkins
94525247f9 Merge "JavaScript use policy" 2013-12-11 12:43:42 +00:00
Radomir Dopieralski
e6467692d4 JavaScript use policy
Add a point to HACKING.rst pointing to the Horizon docs about
contributing.

Add information about JavaScript support policy to the contributing
docs.

The policy is based on:
http://lists.openstack.org/pipermail/openstack-dev/2013-November/020342.html

Change-Id: I16a51c7ab7faf68d6e7984c113da175c5c08650d
2013-12-10 14:34:42 +01:00
Ana Krivokapic
d3c91de71a Improve contributor documentation
Fix various errors in the contributor documentation:

- Factual mistakes (wrong file locations, etc)
- Formatting errors
- Typos

Change-Id: I4863ca10a532ac74491cfb19f8382e3d5287d2f3
2013-12-03 20:05:01 +01:00
Julie Pichon
9005837b54 Update "Getting Started" Contributing docs
As of March 2013, joining the openstack-cla team on Launchpad is no
longer required.

Change-Id: I342f9600c1b6689780086894746de70ea15577a5
2013-04-02 13:34:08 +01:00
Clark Boylan
f1a8e0c54f Move docs to doc.
To better facilitate the building and publishing of sphinx
documentation by Jenkins we are moving all openstack projects with
sphinx documentation to a common doc tree structure. Documentation
goes in project/doc and build results go in project/doc/build.

Change-Id: Ic523a716e4113198b777d6dc3db8bb8a729e7696
2012-06-12 11:41:04 -07:00