Mercurial > web-octave

annotate README.md @ 82:bc79072a8169 kai

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
Update README with suggestion for future deployment.
author Kai T. Ohlhus <k.ohlhus@gmail.com>
date Mon, 17 Oct 2016 18:34:14 +0200
parents 48f5e0fda5a8
children 3269c95e98d9
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
31
beb4387a8937 Create README.md
Alex Krolick <whokilledtheelectricmonk@gmail.com>
parents:
diff changeset
1 # octave-web
82
bc79072a8169 Update README with suggestion for future deployment.
Kai T. Ohlhus <k.ohlhus@gmail.com>
parents: 64
diff changeset
2
bc79072a8169 Update README with suggestion for future deployment.
Kai T. Ohlhus <k.ohlhus@gmail.com>
parents: 64
diff changeset
3 This is the [http://www.octave.org][1] website development repository.
bc79072a8169 Update README with suggestion for future deployment.
Kai T. Ohlhus <k.ohlhus@gmail.com>
parents: 64
diff changeset
4
bc79072a8169 Update README with suggestion for future deployment.
Kai T. Ohlhus <k.ohlhus@gmail.com>
parents: 64
diff changeset
5 The development and deployment workflow in short:
31
beb4387a8937 Create README.md
Alex Krolick <whokilledtheelectricmonk@gmail.com>
parents:
diff changeset
6
82
bc79072a8169 Update README with suggestion for future deployment.
Kai T. Ohlhus <k.ohlhus@gmail.com>
parents: 64
diff changeset
7 1. The website is developed in this [web-octave][2] Mercurial repository.
bc79072a8169 Update README with suggestion for future deployment.
Kai T. Ohlhus <k.ohlhus@gmail.com>
parents: 64
diff changeset
8 2. Static HTML pages are generated from this [web-octave][2] repository
bc79072a8169 Update README with suggestion for future deployment.
Kai T. Ohlhus <k.ohlhus@gmail.com>
parents: 64
diff changeset
9 and are deployed at the [Savannah CVS][3] repository.
bc79072a8169 Update README with suggestion for future deployment.
Kai T. Ohlhus <k.ohlhus@gmail.com>
parents: 64
diff changeset
10 3. After deploying the static pages, they are visible from
bc79072a8169 Update README with suggestion for future deployment.
Kai T. Ohlhus <k.ohlhus@gmail.com>
parents: 64
diff changeset
11 [http://www.octave.org][1], that redirects to
bc79072a8169 Update README with suggestion for future deployment.
Kai T. Ohlhus <k.ohlhus@gmail.com>
parents: 64
diff changeset
12 [https://www.gnu.org/software/octave][4].
64
48f5e0fda5a8 Add repository information.
Kai T. Ohlhus <k.ohlhus@gmail.com>
parents: 31
diff changeset
13
82
bc79072a8169 Update README with suggestion for future deployment.
Kai T. Ohlhus <k.ohlhus@gmail.com>
parents: 64
diff changeset
14 [1]: http://www.octave.org
bc79072a8169 Update README with suggestion for future deployment.
Kai T. Ohlhus <k.ohlhus@gmail.com>
parents: 64
diff changeset
15 [2]: http://hg.octave.org/web-octave
bc79072a8169 Update README with suggestion for future deployment.
Kai T. Ohlhus <k.ohlhus@gmail.com>
parents: 64
diff changeset
16 [3]: http://web.cvs.savannah.gnu.org/viewvc/octave/?root=octave
bc79072a8169 Update README with suggestion for future deployment.
Kai T. Ohlhus <k.ohlhus@gmail.com>
parents: 64
diff changeset
17 [4]: https://www.gnu.org/software/octave
64
48f5e0fda5a8 Add repository information.
Kai T. Ohlhus <k.ohlhus@gmail.com>
parents: 31
diff changeset
18
82
bc79072a8169 Update README with suggestion for future deployment.
Kai T. Ohlhus <k.ohlhus@gmail.com>
parents: 64
diff changeset
19
bc79072a8169 Update README with suggestion for future deployment.
Kai T. Ohlhus <k.ohlhus@gmail.com>
parents: 64
diff changeset
20
bc79072a8169 Update README with suggestion for future deployment.
Kai T. Ohlhus <k.ohlhus@gmail.com>
parents: 64
diff changeset
21 ## Development
bc79072a8169 Update README with suggestion for future deployment.
Kai T. Ohlhus <k.ohlhus@gmail.com>
parents: 64
diff changeset
22
bc79072a8169 Update README with suggestion for future deployment.
Kai T. Ohlhus <k.ohlhus@gmail.com>
parents: 64
diff changeset
23 ### Getting the sources
64
48f5e0fda5a8 Add repository information.
Kai T. Ohlhus <k.ohlhus@gmail.com>
parents: 31
diff changeset
24
82
bc79072a8169 Update README with suggestion for future deployment.
Kai T. Ohlhus <k.ohlhus@gmail.com>
parents: 64
diff changeset
25 Anyone is free to clone this development repository, simply type
bc79072a8169 Update README with suggestion for future deployment.
Kai T. Ohlhus <k.ohlhus@gmail.com>
parents: 64
diff changeset
26
bc79072a8169 Update README with suggestion for future deployment.
Kai T. Ohlhus <k.ohlhus@gmail.com>
parents: 64
diff changeset
27 hg clone http://hg.octave.org/web-octave
31
beb4387a8937 Create README.md
Alex Krolick <whokilledtheelectricmonk@gmail.com>
parents:
diff changeset
28
82
bc79072a8169 Update README with suggestion for future deployment.
Kai T. Ohlhus <k.ohlhus@gmail.com>
parents: 64
diff changeset
29 to get anonymous read access without writing privileges.
bc79072a8169 Update README with suggestion for future deployment.
Kai T. Ohlhus <k.ohlhus@gmail.com>
parents: 64
diff changeset
30 To push your changes, please contact the octave developers at
bc79072a8169 Update README with suggestion for future deployment.
Kai T. Ohlhus <k.ohlhus@gmail.com>
parents: 64
diff changeset
31 `maintainers@octave.org`.
64
48f5e0fda5a8 Add repository information.
Kai T. Ohlhus <k.ohlhus@gmail.com>
parents: 31
diff changeset
32
82
bc79072a8169 Update README with suggestion for future deployment.
Kai T. Ohlhus <k.ohlhus@gmail.com>
parents: 64
diff changeset
33 If you already have writing permissions for this repository,
bc79072a8169 Update README with suggestion for future deployment.
Kai T. Ohlhus <k.ohlhus@gmail.com>
parents: 64
diff changeset
34 you should clone the repository using
64
48f5e0fda5a8 Add repository information.
Kai T. Ohlhus <k.ohlhus@gmail.com>
parents: 31
diff changeset
35
48f5e0fda5a8 Add repository information.
Kai T. Ohlhus <k.ohlhus@gmail.com>
parents: 31
diff changeset
36 hg clone ssh://gnuoctave@octave.org/hg/web-octave
48f5e0fda5a8 Add repository information.
Kai T. Ohlhus <k.ohlhus@gmail.com>
parents: 31
diff changeset
37
82
bc79072a8169 Update README with suggestion for future deployment.
Kai T. Ohlhus <k.ohlhus@gmail.com>
parents: 64
diff changeset
38
bc79072a8169 Update README with suggestion for future deployment.
Kai T. Ohlhus <k.ohlhus@gmail.com>
parents: 64
diff changeset
39
bc79072a8169 Update README with suggestion for future deployment.
Kai T. Ohlhus <k.ohlhus@gmail.com>
parents: 64
diff changeset
40 ### Building requisites
bc79072a8169 Update README with suggestion for future deployment.
Kai T. Ohlhus <k.ohlhus@gmail.com>
parents: 64
diff changeset
41
bc79072a8169 Update README with suggestion for future deployment.
Kai T. Ohlhus <k.ohlhus@gmail.com>
parents: 64
diff changeset
42 To build the static website, you need to install [Jekyll][5] and a few more
bc79072a8169 Update README with suggestion for future deployment.
Kai T. Ohlhus <k.ohlhus@gmail.com>
parents: 64
diff changeset
43 tools from [Rubygems][6]. Just type
bc79072a8169 Update README with suggestion for future deployment.
Kai T. Ohlhus <k.ohlhus@gmail.com>
parents: 64
diff changeset
44
bc79072a8169 Update README with suggestion for future deployment.
Kai T. Ohlhus <k.ohlhus@gmail.com>
parents: 64
diff changeset
45 gem install jekyll jekyll-octicons pygments.rb
bc79072a8169 Update README with suggestion for future deployment.
Kai T. Ohlhus <k.ohlhus@gmail.com>
parents: 64
diff changeset
46
bc79072a8169 Update README with suggestion for future deployment.
Kai T. Ohlhus <k.ohlhus@gmail.com>
parents: 64
diff changeset
47 [5]: https://jekyllrb.com/
bc79072a8169 Update README with suggestion for future deployment.
Kai T. Ohlhus <k.ohlhus@gmail.com>
parents: 64
diff changeset
48 [6]: https://rubygems.org/
bc79072a8169 Update README with suggestion for future deployment.
Kai T. Ohlhus <k.ohlhus@gmail.com>
parents: 64
diff changeset
49
bc79072a8169 Update README with suggestion for future deployment.
Kai T. Ohlhus <k.ohlhus@gmail.com>
parents: 64
diff changeset
50
bc79072a8169 Update README with suggestion for future deployment.
Kai T. Ohlhus <k.ohlhus@gmail.com>
parents: 64
diff changeset
51
bc79072a8169 Update README with suggestion for future deployment.
Kai T. Ohlhus <k.ohlhus@gmail.com>
parents: 64
diff changeset
52 ### Building the static website
bc79072a8169 Update README with suggestion for future deployment.
Kai T. Ohlhus <k.ohlhus@gmail.com>
parents: 64
diff changeset
53
bc79072a8169 Update README with suggestion for future deployment.
Kai T. Ohlhus <k.ohlhus@gmail.com>
parents: 64
diff changeset
54 All relevant information for Jekyll to build the static website is located
bc79072a8169 Update README with suggestion for future deployment.
Kai T. Ohlhus <k.ohlhus@gmail.com>
parents: 64
diff changeset
55 in the file `_config.yml`.
bc79072a8169 Update README with suggestion for future deployment.
Kai T. Ohlhus <k.ohlhus@gmail.com>
parents: 64
diff changeset
56 Typing
bc79072a8169 Update README with suggestion for future deployment.
Kai T. Ohlhus <k.ohlhus@gmail.com>
parents: 64
diff changeset
57
bc79072a8169 Update README with suggestion for future deployment.
Kai T. Ohlhus <k.ohlhus@gmail.com>
parents: 64
diff changeset
58 jekyll build
bc79072a8169 Update README with suggestion for future deployment.
Kai T. Ohlhus <k.ohlhus@gmail.com>
parents: 64
diff changeset
59
bc79072a8169 Update README with suggestion for future deployment.
Kai T. Ohlhus <k.ohlhus@gmail.com>
parents: 64
diff changeset
60 from the repositories root directory will build a complete static website
bc79072a8169 Update README with suggestion for future deployment.
Kai T. Ohlhus <k.ohlhus@gmail.com>
parents: 64
diff changeset
61 into the subdirectory `_site` using this information (this directory is
bc79072a8169 Update README with suggestion for future deployment.
Kai T. Ohlhus <k.ohlhus@gmail.com>
parents: 64
diff changeset
62 ignored by Mercurial and will be created on first build).
bc79072a8169 Update README with suggestion for future deployment.
Kai T. Ohlhus <k.ohlhus@gmail.com>
parents: 64
diff changeset
63
bc79072a8169 Update README with suggestion for future deployment.
Kai T. Ohlhus <k.ohlhus@gmail.com>
parents: 64
diff changeset
64 Especially for development, it is beneficial to watch the changes locally
bc79072a8169 Update README with suggestion for future deployment.
Kai T. Ohlhus <k.ohlhus@gmail.com>
parents: 64
diff changeset
65 before pushing any changes.
bc79072a8169 Update README with suggestion for future deployment.
Kai T. Ohlhus <k.ohlhus@gmail.com>
parents: 64
diff changeset
66 Jekyll provides a local webserver by typing
bc79072a8169 Update README with suggestion for future deployment.
Kai T. Ohlhus <k.ohlhus@gmail.com>
parents: 64
diff changeset
67
bc79072a8169 Update README with suggestion for future deployment.
Kai T. Ohlhus <k.ohlhus@gmail.com>
parents: 64
diff changeset
68 jekyll serve
bc79072a8169 Update README with suggestion for future deployment.
Kai T. Ohlhus <k.ohlhus@gmail.com>
parents: 64
diff changeset
69
bc79072a8169 Update README with suggestion for future deployment.
Kai T. Ohlhus <k.ohlhus@gmail.com>
parents: 64
diff changeset
70 and rebuilds the whole static website automatically, as it monitors any
bc79072a8169 Update README with suggestion for future deployment.
Kai T. Ohlhus <k.ohlhus@gmail.com>
parents: 64
diff changeset
71 file changes.
bc79072a8169 Update README with suggestion for future deployment.
Kai T. Ohlhus <k.ohlhus@gmail.com>
parents: 64
diff changeset
72
bc79072a8169 Update README with suggestion for future deployment.
Kai T. Ohlhus <k.ohlhus@gmail.com>
parents: 64
diff changeset
73
31
beb4387a8937 Create README.md
Alex Krolick <whokilledtheelectricmonk@gmail.com>
parents:
diff changeset
74
beb4387a8937 Create README.md
Alex Krolick <whokilledtheelectricmonk@gmail.com>
parents:
diff changeset
75 ## Deploying
64
48f5e0fda5a8 Add repository information.
Kai T. Ohlhus <k.ohlhus@gmail.com>
parents: 31
diff changeset
76
82
bc79072a8169 Update README with suggestion for future deployment.
Kai T. Ohlhus <k.ohlhus@gmail.com>
parents: 64
diff changeset
77 After building the static website from [web-octave][2] into the
bc79072a8169 Update README with suggestion for future deployment.
Kai T. Ohlhus <k.ohlhus@gmail.com>
parents: 64
diff changeset
78 the subdirectory `_site` using Jekyll it can be deployed at the
bc79072a8169 Update README with suggestion for future deployment.
Kai T. Ohlhus <k.ohlhus@gmail.com>
parents: 64
diff changeset
79 [Savannah CVS][3] repository to become visible to the world.
31
beb4387a8937 Create README.md
Alex Krolick <whokilledtheelectricmonk@gmail.com>
parents:
diff changeset
80
82
bc79072a8169 Update README with suggestion for future deployment.
Kai T. Ohlhus <k.ohlhus@gmail.com>
parents: 64
diff changeset
81 Therefore, checkout the [Savannah CVS][3] repository somewhere
bc79072a8169 Update README with suggestion for future deployment.
Kai T. Ohlhus <k.ohlhus@gmail.com>
parents: 64
diff changeset
82 outside the [web-octave][2] directory, typing
64
48f5e0fda5a8 Add repository information.
Kai T. Ohlhus <k.ohlhus@gmail.com>
parents: 31
diff changeset
83
48f5e0fda5a8 Add repository information.
Kai T. Ohlhus <k.ohlhus@gmail.com>
parents: 31
diff changeset
84 export CVS_RSH=ssh
82
bc79072a8169 Update README with suggestion for future deployment.
Kai T. Ohlhus <k.ohlhus@gmail.com>
parents: 64
diff changeset
85 cvs -z3 -d:ext:<Savannah account>@cvs.savannah.gnu.org:/web/octave checkout -P octave
bc79072a8169 Update README with suggestion for future deployment.
Kai T. Ohlhus <k.ohlhus@gmail.com>
parents: 64
diff changeset
86
bc79072a8169 Update README with suggestion for future deployment.
Kai T. Ohlhus <k.ohlhus@gmail.com>
parents: 64
diff changeset
87 Now the following steps are required for deployment
bc79072a8169 Update README with suggestion for future deployment.
Kai T. Ohlhus <k.ohlhus@gmail.com>
parents: 64
diff changeset
88 (see [here][7] and [here][8] for some introduction to CVS):
bc79072a8169 Update README with suggestion for future deployment.
Kai T. Ohlhus <k.ohlhus@gmail.com>
parents: 64
diff changeset
89
bc79072a8169 Update README with suggestion for future deployment.
Kai T. Ohlhus <k.ohlhus@gmail.com>
parents: 64
diff changeset
90 1. Remove all previous files in the target directory,
bc79072a8169 Update README with suggestion for future deployment.
Kai T. Ohlhus <k.ohlhus@gmail.com>
parents: 64
diff changeset
91 *but no directories at all or CVS related stuff*!
bc79072a8169 Update README with suggestion for future deployment.
Kai T. Ohlhus <k.ohlhus@gmail.com>
parents: 64
diff changeset
92 This is due to a [limitation of CVS][9].
bc79072a8169 Update README with suggestion for future deployment.
Kai T. Ohlhus <k.ohlhus@gmail.com>
parents: 64
diff changeset
93
bc79072a8169 Update README with suggestion for future deployment.
Kai T. Ohlhus <k.ohlhus@gmail.com>
parents: 64
diff changeset
94 find octave -type f -not -path "*/CVS/*" -exec rm -f '{}' \;
bc79072a8169 Update README with suggestion for future deployment.
Kai T. Ohlhus <k.ohlhus@gmail.com>
parents: 64
diff changeset
95
bc79072a8169 Update README with suggestion for future deployment.
Kai T. Ohlhus <k.ohlhus@gmail.com>
parents: 64
diff changeset
96 *Note:* `octave` in the command above is the name of the checked out
bc79072a8169 Update README with suggestion for future deployment.
Kai T. Ohlhus <k.ohlhus@gmail.com>
parents: 64
diff changeset
97 [Savannah CVS][3] repository.
bc79072a8169 Update README with suggestion for future deployment.
Kai T. Ohlhus <k.ohlhus@gmail.com>
parents: 64
diff changeset
98
bc79072a8169 Update README with suggestion for future deployment.
Kai T. Ohlhus <k.ohlhus@gmail.com>
parents: 64
diff changeset
99 2. Now copy the new content of [web-octave][2] subdirectory `_site` into the
bc79072a8169 Update README with suggestion for future deployment.
Kai T. Ohlhus <k.ohlhus@gmail.com>
parents: 64
diff changeset
100 [Savannah CVS][3] repository.
bc79072a8169 Update README with suggestion for future deployment.
Kai T. Ohlhus <k.ohlhus@gmail.com>
parents: 64
diff changeset
101
bc79072a8169 Update README with suggestion for future deployment.
Kai T. Ohlhus <k.ohlhus@gmail.com>
parents: 64
diff changeset
102 3. Then in the [Savannah CVS][3] repository:
bc79072a8169 Update README with suggestion for future deployment.
Kai T. Ohlhus <k.ohlhus@gmail.com>
parents: 64
diff changeset
103
bc79072a8169 Update README with suggestion for future deployment.
Kai T. Ohlhus <k.ohlhus@gmail.com>
parents: 64
diff changeset
104 cd octave
bc79072a8169 Update README with suggestion for future deployment.
Kai T. Ohlhus <k.ohlhus@gmail.com>
parents: 64
diff changeset
105
bc79072a8169 Update README with suggestion for future deployment.
Kai T. Ohlhus <k.ohlhus@gmail.com>
parents: 64
diff changeset
106 1. Remove all no longer existent files
bc79072a8169 Update README with suggestion for future deployment.
Kai T. Ohlhus <k.ohlhus@gmail.com>
parents: 64
diff changeset
107
bc79072a8169 Update README with suggestion for future deployment.
Kai T. Ohlhus <k.ohlhus@gmail.com>
parents: 64
diff changeset
108 cvs remove
bc79072a8169 Update README with suggestion for future deployment.
Kai T. Ohlhus <k.ohlhus@gmail.com>
parents: 64
diff changeset
109
bc79072a8169 Update README with suggestion for future deployment.
Kai T. Ohlhus <k.ohlhus@gmail.com>
parents: 64
diff changeset
110 2. Add all potential new directories to CVS
bc79072a8169 Update README with suggestion for future deployment.
Kai T. Ohlhus <k.ohlhus@gmail.com>
parents: 64
diff changeset
111
bc79072a8169 Update README with suggestion for future deployment.
Kai T. Ohlhus <k.ohlhus@gmail.com>
parents: 64
diff changeset
112 find . -type d -not -name "CVS" -exec cvs add '{}' \;
bc79072a8169 Update README with suggestion for future deployment.
Kai T. Ohlhus <k.ohlhus@gmail.com>
parents: 64
diff changeset
113
bc79072a8169 Update README with suggestion for future deployment.
Kai T. Ohlhus <k.ohlhus@gmail.com>
parents: 64
diff changeset
114 3. Add all potential new files to CVS (the [following command][10]
bc79072a8169 Update README with suggestion for future deployment.
Kai T. Ohlhus <k.ohlhus@gmail.com>
parents: 64
diff changeset
115 proved to me fast)
bc79072a8169 Update README with suggestion for future deployment.
Kai T. Ohlhus <k.ohlhus@gmail.com>
parents: 64
diff changeset
116
bc79072a8169 Update README with suggestion for future deployment.
Kai T. Ohlhus <k.ohlhus@gmail.com>
parents: 64
diff changeset
117 find . -type f | grep -v CVS | xargs cvs add
bc79072a8169 Update README with suggestion for future deployment.
Kai T. Ohlhus <k.ohlhus@gmail.com>
parents: 64
diff changeset
118
bc79072a8169 Update README with suggestion for future deployment.
Kai T. Ohlhus <k.ohlhus@gmail.com>
parents: 64
diff changeset
119 4. Commit the chages to get online
bc79072a8169 Update README with suggestion for future deployment.
Kai T. Ohlhus <k.ohlhus@gmail.com>
parents: 64
diff changeset
120
bc79072a8169 Update README with suggestion for future deployment.
Kai T. Ohlhus <k.ohlhus@gmail.com>
parents: 64
diff changeset
121 cvs commit
bc79072a8169 Update README with suggestion for future deployment.
Kai T. Ohlhus <k.ohlhus@gmail.com>
parents: 64
diff changeset
122
bc79072a8169 Update README with suggestion for future deployment.
Kai T. Ohlhus <k.ohlhus@gmail.com>
parents: 64
diff changeset
123 Now everything should be visible to the world.
bc79072a8169 Update README with suggestion for future deployment.
Kai T. Ohlhus <k.ohlhus@gmail.com>
parents: 64
diff changeset
124
bc79072a8169 Update README with suggestion for future deployment.
Kai T. Ohlhus <k.ohlhus@gmail.com>
parents: 64
diff changeset
125 [7]: https://savannah.nongnu.org/projects/cvs
bc79072a8169 Update README with suggestion for future deployment.
Kai T. Ohlhus <k.ohlhus@gmail.com>
parents: 64
diff changeset
126 [8]: http://www.cs.umb.edu/~srevilak/cvs.html
bc79072a8169 Update README with suggestion for future deployment.
Kai T. Ohlhus <k.ohlhus@gmail.com>
parents: 64
diff changeset
127 [9]: https://web.archive.org/web/20140629054602/http://ximbiot.com/cvs/manual/cvs-1.11.23/cvs_7.html#SEC69
bc79072a8169 Update README with suggestion for future deployment.
Kai T. Ohlhus <k.ohlhus@gmail.com>
parents: 64
diff changeset
128 [10]: http://stackoverflow.com/questions/5071/how-to-add-cvs-directories-recursively