Permalink
Browse files

Add README pointing to zanata-platform; remove files

1 parent 0f926f8 commit 1a51305a0183ad195dcdf6351640b2dfcec8de82 @seanf seanf committed Oct 20, 2016
Showing 2,830 changed files with 89 additions and 380,542 deletions.
View
@@ -1,44 +0,0 @@
-# See https://help.github.com/articles/dealing-with-line-endings
-
-# This setting tells git always to normalize the files specified.
-# When committed they are stored with LF, on checkout they are
-# converted to the OS's native line endings.
-* text
-
-# Explicitly declare text files we want to always be normalized and converted
-# to native line endings on checkout.
-*.c text
-*.css text
-*.csv text
-*.groovy text
-*.h text
-*.html text
-*.ini text
-*.java text
-*.js text
-*.launch text
-*.po text
-*.pot text
-*.properties text
-*.sh text
-*.sql text
-*.txt text
-*.xhtml text
-*.xml text
-
-# Declare files that will always have CRLF line endings on checkout.
-*.sln text eol=crlf
-
-# Denote all files that are truly binary and should not be modified.
-*.gif binary
-*.jar binary
-*.jpg binary
-*.png binary
-*.idml binary
-*.odt binary
-*.odg binary
-*.odp binary
-*.ods binary
-*.ico binary
-*.eot binary
-*.ttf binary
@@ -1,50 +1,76 @@
-JIRA issue URL: *[paste URL here]*
-
-*[Add a short description of what is changed here.]*
-
-
-## Reviewer tasks
-
-The following is based on the
-[Zanata Development Guidelines](https://github.com/zanata/zanata-server/wiki/Development-Guidelines).
-As a reviewer, you should check the guidelines regularly for updates, and just
-to refresh your memory.
-
-
-The reviewer can use this list for reference to make sure
-they have considered all the important points.
-
-Use the checkboxes or not, whatever works best for you.
-
- - Code quality
- - [ ] Code passes style check (checkstyle/eslint)
- - [ ] Code is clear and concise
- - [ ] UI code is internationalised
- - [ ] Code has adequate comments where appropriate
- - Code is in an appropriate place
- - [ ] Classes are in appropriate packages
- - [ ] Code fits with class's responsibilities (SRP)
- - [ ] Configuration files are documented enough
- - If code is removed
- - [ ] No remaining code references the removed code
- - [ ] No orphaned rewrite rules
- - [ ] No orphaned config settings
- - [ ] No remaining comments refer to the removed code
- - [ ] Unused imports and libraries are removed
- - Testing
- - [ ] New code has tests
- - [ ] Changed code has tests
- - [ ] All tests pass
- - [ ] Test coverage stable or increased
- - Documentation
- - [ ] New features are documented
- - [ ] Docs removed for deleted features
- - [ ] Docs updated for all changed features
- - [ ] Developer/sysadmin docs updated if appropriate
- - If there are new dependencies
- - [ ] Does each new dependency pass all the
- [Considerations for new dependencies](https://github.com/zanata/zanata-server/wiki/Development-Guidelines#new-technologies-and-dependencies)?
-
-
-----
-*This template can be updated in .github/PULL_REQUEST_TEMPLATE.md*
+# IMPORTANT: Zanata's source code has moved.
+
+To get the latest code, please visit the new repository: https://github.com/zanata/zanata-platform
+
+Please do not fork or clone Zanata from this repository. This repository is kept for reference only.
+
+Please submit pull requests to the zanata-platform repository.
+
+Find out about Zanata here: http://zanata.org/
+
+***
+
+
+Zanata
+=====
+
+Zanata is a web-based system for translators to translate
+documentation and software online using a web-browser. It is
+written in Java and uses modern web technologies like JBoss,
+Seam, GWT, Hibernate, and a REST API. It currently supports
+translation of DocBook/Publican documentation through PO
+files. Projects can be uploaded to and downloaded from a Zanata
+server using a Maven plugin or a Python client.
+
+For *developers and writers*: By using Zanata for
+your document translations, you can open up your project for
+translations without opening your entire project in version
+control.
+
+For *translators*: No need to deal with PO files,
+gettext or a version control system - just log in to the website, join
+a language team and start translating, with translation memory (history
+of similar translations) and the ability to see updates from other
+translators in seconds.
+
+
+Zanata is Free software, licensed under the [LGPL][].
+
+[LGPL]: http://www.gnu.org/licenses/lgpl-2.1.html
+
+Developers
+----------
+
+### Prerequisites
+
+You will need:
+- Java SDK 8 (OpenJDK recommended)
+- npm
+- Mysql or MariaDB
+- JBoss EAP 7 or WildFly 10
+
+### Building
+
+#### Quickly build a .war file
+
+[`etc/scripts/quickbuild.sh`](etc/scripts/quickbuild.sh) - Builds the project
+as quickly as possible, targeting both Firefox and Chrome when building GWT
+components, and skipping all checks and verifications (i.e. tests, checkstyle, etc)
+
+If you wish to build GWT components for chrome or firefox only, you can specify the
+`-c` and `-f` arguments respectively.
+
+The `-h` argument prints the script's help.
+
+#### Build and run a server for testing
+
+[`etc/scripts/cargowait.sh`](etc/scripts/cargowait.sh) - Builds the Zanata artifact
+and starts a JBoss server using the cargo plugin. This script is particularly
+useful for starting a Zanata instance with the aim of running functional tests
+from an IDE.
+
+The `-h` argument prints the script's help.
+
+#### Development using docker (experimental)
+
+For a quick Zanata development environment with Docker, please visit the [docker README](docker/README.md).
View
@@ -1,75 +0,0 @@
-
-*~
-*.patch
-# Include patches used for the publick package
-!/zanata-war/etc/public-package/patches/**/*.patch
-
-*.sedbak
-zanatasearchindex/
-test-output/
-hs_err_pid*.log
-localDB.log
-localDB.properties
-
-/.pc/
-/.ant-targets-build.xml
-/.pages.xml.spdia
-temp-testng-customsuite.xml
-*_qc.properties
-
-# eclipse and maven stuff
-.classpath
-.metadata/
-.settings/
-.project
-bin/
-/target/
-/*/target/
-/*/*/target/
-*.orig
-.pages.xml.spdia
-# eclipse scrapbook page:
-*.jpage
-
-*.pdf
-
-# idea
-*.idea/
-*.iml
-
-# kde related
-*.directory
-
-#gwt related
-.gwt-log
-*.gwt-tmp
-/zanata-war/src/main/webapp/WEB-INF/deploy/
-/zanata-war/src/main/webapp/webtrans/
-
-# vim
-*.swp
-
-
-# binary files
-*.class
-*.cli
-*.exe
-*.jar
-*.war
-*.zip
-
-# temp files
-*.log
-*.temp
-*.tmp
-/tmp*
-*.bak
-
-# Gradle files
-.gradle/
-
-# other things that really ought to go under target/
-ehcache.disk.store.dir/
-frontend/src/main/web/jsconfig.json
-frontend/src/main/web/.vscode/launch.json
-frontend/src/main/web/.vscode/tasks.json
View
@@ -1,49 +0,0 @@
-<settings xmlns="http://maven.apache.org/POM/4.0.0"
- xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
- xsi:schemaLocation="http://maven.apache.org/POM/4.0.0
- http://maven.apache.org/xsd/settings-1.0.0.xsd">
-
- <profiles>
-
- <!--
- Repository group which contains Zanata snapshots and releases (before they sync to Central).
- Includes Zanata api, client, common, parent, but not server.
- See https://docs.sonatype.org/display/Repository/Sonatype+OSS+Maven+Repository+Usage+Guide#SonatypeOSSMavenRepositoryUsageGuide-4.MavenRepositories
- -->
- <profile>
- <id>oss-public</id>
- <activation>
- <property>
- <name>!oss.public.off</name>
- </property>
- </activation>
- <repositories>
- <repository>
- <id>oss-public</id>
- <name>oss-public</name>
- <url>https://oss.sonatype.org/content/groups/public/</url>
- <releases>
- <enabled>true</enabled>
- </releases>
- <snapshots>
- <enabled>true</enabled>
- </snapshots>
- </repository>
- </repositories>
- <pluginRepositories>
- <pluginRepository>
- <id>oss-public</id>
- <name>oss-public</name>
- <url>https://oss.sonatype.org/content/groups/public/</url>
- <releases>
- <enabled>true</enabled>
- </releases>
- <snapshots>
- <enabled>true</enabled>
- </snapshots>
- </pluginRepository>
- </pluginRepositories>
- </profile>
-
- </profiles>
-</settings>
View
@@ -1,38 +0,0 @@
-# use http://docs.travis-ci.com/user/workers/container-based-infrastructure/
-sudo: false
-
-# cache local Maven repo: http://docs.travis-ci.com/user/caching/
-cache:
- directories:
- - $HOME/.m2/repository
-
-language: java
-
-# Use the 'true' command to avoid up-front dependency fetching, for faster builds
-# See http://docs.travis-ci.com/user/languages/java/#Dependency-Management
-install: /bin/true
-
-# Travis build logs need to be small (aim for less than 4MB or 10,000 lines),
-# so we try to minimise unwanted logging. However, Travis will kill the build
-# if nothing is logged for 10 minutes (20 with travis_wait), so we do need
-# some logging.
-
-script: |
- mvn verify \
- --batch-mode \
- --settings .travis-settings.xml \
- -Dgwt.validateOnly \
- -Dappserver=wildfly8 \
- -DskipFuncTests \
- -Dmaven.test.redirectTestOutputToFile \
- -DstaticAnalysis | \
- egrep -v \
- '^(\[INFO\] Download|'\
- '\[WARNING\] Could not validate integrity of download from|'\
- '\[WARNING\] Checksum validation failed, no checksums available for)'
-
-jdk:
- - oraclejdk8
-
-matrix:
- fast_finish: true
Oops, something went wrong.

0 comments on commit 1a51305

Please sign in to comment.