From: mh Date: Sun, 8 Dec 2002 07:05:56 +0000 (+0000) Subject: merge in doc from MIR_1_0 X-Git-Tag: BEFORE_MERGE_1_1~411 X-Git-Url: http://erislabs.net/gitweb/?p=mir.git;a=commitdiff_plain;h=14056d8a61e9e0d01d0de17cff2d9e548cc8e3ed merge in doc from MIR_1_0 --- diff --git a/doc/CODINGSTYLE b/doc/CODINGSTYLE new file mode 100755 index 00000000..654af7ac --- /dev/null +++ b/doc/CODINGSTYLE @@ -0,0 +1,36 @@ +last changed: $Date: 2002/12/08 07:05:56 $ +------------------------ + +please us spaces not tabs for indents. all indents should be 2 spaces wide. + +If you use the vim editor, below is a good .vimrc entry for java files that +makes all tabs appear 2 chars. wide and makes indenting using the TAB key create +2 real spaces. It also sets the shiftwidth to 2 spaces. + +in your .vimrc add the following: + +autocmd FileType java source /path/to/file/.vimrc.java + +create .vimrc.java and add the following: + +set tabstop=2 +set shiftwidth=2 +set expandtab + +if you can, please try to make your code terminal friendly so a line should +not be more than 80 characters wide pls. Not all mir code is like this and it +is not required (well what really is required?) + +For java code, class names usually begin with a capital letter. e.g +StringUtils.java. Names for variables and methods should begin with a lower case +letter. However, if a variable or method is composed of more than one word +(glued together of course) the second and following word(s) should begin with +a capitalized letter. for example in the following code snippet: + +String name = "titi"; +Entity contentEntity = getContent(); +contentEntity.setPropertyForValue("name", name); + +some java code convention docs: + +http://java.sun.com/docs/codeconv/html/CodeConvTOC.doc.html diff --git a/doc/KNOWN_BUGS b/doc/KNOWN_BUGS new file mode 100755 index 00000000..68474747 --- /dev/null +++ b/doc/KNOWN_BUGS @@ -0,0 +1,21 @@ +last changed: $Date: 2002/12/08 07:05:56 $ 2002 mir-coders +------------------------------------------------------------------- + +In all versions +=============== + +* the JAI library used for creating thumnails of images will often make the + thumbnail for a GIF or PNG image look like it has some television set snow in + it. The workaround would be to upload Jpeg images if you can. We are looking + into replacing JAI with another library. +* when deleting an item, be it an article or an uploaded media file, the action + will remove the data/meta-data from the DB and prevent it from show up in + lists, but it will not delete the file from the filesystem. hopefully this + will be fixed before 1.1.0 is released and in 1.0.1. (FIXME: is this still a + problem in the HEAD branch?) +* single quotes in text get convert to an HTML encoding when stored in the DB.. + it is a quickhack that we have to do cause are persistance layer can't handle + them when doing prepared statements.. (FIXME: is this still in HEAD?) +* some obscure "under certain conditions" corner cases listed in our bug tracker + at https://prod.indymedia.nl/mantis +* some others that I'm forgetting now. diff --git a/doc/MAINTENANCE.postgresql b/doc/MAINTENANCE.postgresql new file mode 100755 index 00000000..df5cae54 --- /dev/null +++ b/doc/MAINTENANCE.postgresql @@ -0,0 +1,39 @@ +To dump mir database : + pg_dumplo -a -d -s /dumpdir/dir + pg_dump -c -D -f /dumpdir/.sql +this generates a dir with all blobs and a sql-file with all data. + +To restore the database: + psql < .sql + pgdump_lo -i -d -s /dumpdir/dir + +Every once in a while (or make a script) postgresql database should +be "cleaned". See postgresql docs for commands VACUUM and VACUUM ANALYZE + +Every once in a while (or make a script) postgresql database should +be "cleaned". See postgresql docs for commands VACUUM and VACUUM ANALYZE + +We also have misc. perl scripts to merge Large Objects from other DB's. +these can be used as a basis to write your own custom scripts. + +USER MANAGMENT IN POSTGRESQL + +-- set owner of datbase +select * from pg_database; +select * from pg_user; +update pg_database set datdba=ID_FROM_PG_USER where datname=DATABASENAME + +-- find all tables to grant privs / select is just building sql +-- to be exectued + +select 'grant all on '||relname||' to "de_indy";' +from pg_class +where relname not like 'pg%' +order by relname; + +-- alter table owner / select is just building sql +-- to be exectued +select 'alter table '||relname||' owner to "de_indy";' +from pg_class +where relname not like 'pg%' +order by relname; \ No newline at end of file diff --git a/doc/README b/doc/README new file mode 100755 index 00000000..6b77b29c --- /dev/null +++ b/doc/README @@ -0,0 +1,23 @@ +last changed $Date: 2002/12/08 07:05:56 $ +----------------------------------------- + +Mir is an Open-Source content managment system, designed to run an +indymedia(type) website. Besides powering several indymedia sites, a number of +progessive organizations use Mir customized for their own needs. Mir aims to +provide sophisticated functionality, for example, complete multi-lingual content +production, editing, administration, and presentation, while retaining the +ability to be run on less than top of the line hardware through extensive static +caching. + +more info at: http://mir.indymedia.org + +development and general questions/discussion happens on the mir-coders mailing +list: mir-coders at lists.indymedia.org + +for archives or to subscribe: + +http://lists.indymedia.org/mailman/listinfo/mir-coders + +mailing list for cvs commits: + +http://lists.indymedia.org/mailman/listinfo/Mir-cvs diff --git a/doc/REPORTING_BUGS b/doc/REPORTING_BUGS new file mode 100755 index 00000000..ab42bf0b --- /dev/null +++ b/doc/REPORTING_BUGS @@ -0,0 +1,44 @@ +last changed: $Date: 2002/12/08 07:05:56 $. 2002 mir-coders +-------------------------------------------------------------------------- + +BUG REPORTS + +Please read this file before sending in a bug report or patch. + +Where to send +============= +Send comments, bug reports, patches, etc. to mir-coders@lists.indymedia.org + +please also take the time to enter a bug in our bug-tracking system: + +https://prod.indymedia.nl/mantis + +What to send +============ +Please specify the relevant versions of the software that you are running Mir +under. i.e JVM name and version (IBM, Sun,..), what compiler was used +(javac or jikes), tomcat version. + +Of course, you should always specify what version of Mir you are running. If you +are running a version check'out of CVS, please specify when you checked it out +and from which branch (e.g MIR_1_0, HEAD..). Also if you can specify the +versions of relevant files using "cvs status". + +If you received an Exception while running Mir, please mail in the "Oops" you +got (if you got one) and try to find and error in one of the Mir/log/* files. +Also, a stack trace can usually be found in one of the tomcat log files. For +example, in tomcat4 you can look at the .../logs/catalina.out file or the +.../logs/localhost_log.yyyy-mm-dd.txt, where the date is of the last time +tomcat was started. Under the Debian package installation, the tomcat logs can +be found under /var/log/tomcat... It is probably similar for other +distributions. If you are using the tarball from jakarta.apache.org, the logs +dir. is directly in the root of the tomcat tree. + +Patches +======= + +Please send in patches that are a diff between an unmodified tree and your tree +with the changes: + +diff -Nur standard-mir-dir your-mir-dir +