~nskaggs/help-app/functional-test-template

« back to all changes in this revision

Viewing changes to HACKING

  • Committer: Daniel Holbach
  • Date: 2015-03-19 17:54:55 UTC
  • mfrom: (111.2.14 1429896)
  • Revision ID: daniel.holbach@canonical.com-20150319175455-sjwdzzy3aqaaiu9u
merged lp:~dholbach/help-app/1429896

Show diffs side-by-side

added added

removed removed

Lines of Context:
50
50
Directory structure
51
51
-------------------
52
52
 
53
 
 
54
 
├── app                 ← Everything related to the devices app.
55
 
│   └── www             ← The viewable content of the app.
56
 
├── edit-here
57
 
│   ├── content
58
 
│   │   └── pages       ← Here is the place to edit the content.
59
 
│   ├── po              ← Translations.
60
 
│   ├── tests           ← Code for automated testing goes here.
61
 
│   └── themes          ← Themes files, both templates and css/js.
62
 
│       ├── phone       ← Phone/device app theme.
63
 
│       └── web         ← Online build (.ubuntu.com) theme.
64
 
└── web                 ← The viewable content of of the online build. 
65
 
 
66
 
Note: Everything in ./app/www and ./web/ is automatically generated.
67
 
      Edit content in ./edit-here/content/pages/ and edit themes in
68
 
      ./edit-here/themes/.
 
53
.
 
54
├── content            ← Here is the place to edit the content.
 
55
│   ├── images         ← Images to be used in the docs.
 
56
│   └── pages          ← Actual text to be edited.
 
57
├── debian             ← Everything related to .deb packaging.
 
58
├── internals          ← Build tools, pelican config.
 
59
│   ├── tests          ← Code for automated testing.
 
60
│   └── translations   ← Python code for handling translations.
 
61
├── po                 ← Translations (.pot and po files).
 
62
└── static
 
63
    ├── app            ← Static files for the click app.
 
64
    └── themes         ← Themes files, both templates and css/js.
 
65
        ├── app
 
66
        └── web
 
67
 
 
68
Note: Everything in .build is automatically generated.
 
69
      Edit content in ./content/pages/ and edit themes in
 
70
      ./static/themes/.
69
71
 
70
72
 
71
73
Prerequisites
96
98
This app is structured in a very simple way. All the content is and all your
97
99
edits happen in
98
100
 
99
 
        ./edit-here/content/pages/
 
101
        ./content/pages/
100
102
 
101
103
The markup for the text is Markdown, which is very easy to learn. Just have 
102
104
a look at http://daringfireball.net/projects/markdown/ and some of the 
104
106
 
105
107
Once you're happy with your edits, change to the top-level directory and run
106
108
 
107
 
        make html
 
109
        make app
108
110
 
109
111
This will also generate translated pages.
110
112
 
111
 
You can find the updated HTML in ./app/www/.
 
113
You can find the updated HTML in ./build/app/www/.
112
114
 
113
115
To launch the app, you can use ubuntu-html5-app-launcher in the www dir, or
114
116
just call
115
117
 
116
118
        make launch
117
119
 
118
 
(This will also run the 'make html' command for you.)
 
120
(This will also run the 'make app' command for you.)
119
121
 
120
122
 
121
123
Creating a click
137
139
 
138
140
        make web
139
141
 
140
 
Find the resulting files in ./web in the top-level directory.
 
142
Find the resulting files in the ./build/web directory.
141
143
 
142
144
We plan to make use of 
143
145
http://www.w3.org/International/questions/qa-apache-lang-neg for publishing
148
150
 
149
151
We love automated testing! We added a couple of test cases to 
150
152
 
151
 
        ./edit-here/tests/
 
153
        ./internals/tests/
152
154
 
153
155
and it would be great if you added more. We want to run these tests 
154
156
whenever we build the package or publish the docs or whatever else. Just
162
164
While you can just generate and install the click package manually,
163
165
we recommend the SDK for testing the phone app.
164
166
 
165
 
You can run the `make html` target to generate the HTML files and then
 
167
You can run the `make appl` target to generate the HTML files and then
166
168
open the app/help.ubuntuhtmlproject file with the Ubuntu SDK IDE.
167
169
 
168
170
From there, you can set up a desktop kit to run it on your host,
177
179
 
178
180
        https://launchpad.net/help-app
179
181
 
180
 
To update the .pot file, simply run the following command in the edit-here/
 
182
To update the .pot file, simply run the following command in the top-level
181
183
directory:
182
184
 
183
185
        make update-pot