HACKING


1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30

To hack on the GStreamer website, here's what to do:

0) Install the cmark-gfm tool (via your package manager or from
   https://github.com/github/cmark-gfm) for markdown support
1) Check out the www module
2) src/autogen.sh
3) create src/htdocs/entities.site by symlinking the applicable entities file
   (entities.site.xxx found in htdocs)
	* entities.site.gnl is for building/running the site locally, you will
	  need to edit the file to correct to local path of your git checkout.
	* entities.site.fdo is for gstreamer freedesktop setup
   (e.g.: cd src/htdocs; ln -s ./entities.site.fdo ./entities.site; cd ../..)
4) mkdir data
5) bin/data-get (this is not needed if you just plan on updating the generated
   content; note that bin/data-get will download no less than 2-3GB of data)
6) make
7) to rebuild the online pages run ./bin/www-update

MISCELLANEOUS NOTES:

Things that are in the data subdirectory and synched with the contents
on the website server by the data-get and data-put scripts. The
things in there are updated by various scripts or by hand.

The data/doc/gstreamer/head/ directory contains subdirs for the CVS version of
the various documentation modules. These should be updated by running 
'make upload' within the docs/ subdirectory of a CVS checkout of each module.

The new-release script updates the data/doc/gstreamer/$VERSION/ copies
automatically, so use that.