From 3ed552595647202f7e34b0bf51d70246180b155f Mon Sep 17 00:00:00 2001 From: Naoki Takezoe Date: Mon, 23 Mar 2015 21:42:49 +0900 Subject: [PATCH] (refs #665)Fix markdown format --- doc/activity.md | 2 ++ doc/auto_update.md | 4 ++-- doc/comment_action.md | 4 ++-- doc/directory.md | 4 ++-- doc/how_to_run.md | 3 ++- doc/notification.md | 3 ++- doc/readme.md | 10 +++++----- doc/{mapping_and_validation.md => validation.md} | 4 ++-- 8 files changed, 19 insertions(+), 15 deletions(-) rename doc/{mapping_and_validation.md => validation.md} (98%) diff --git a/doc/activity.md b/doc/activity.md index bc492405d..7c45dfbbf 100644 --- a/doc/activity.md +++ b/doc/activity.md @@ -1,3 +1,5 @@ +Activity Timeline +======== GitBucket records several types of user activity to ```ACTIVITY``` table. Activity types are shown below: type | message | additional information diff --git a/doc/auto_update.md b/doc/auto_update.md index f5c80b77e..83aa711ca 100644 --- a/doc/auto_update.md +++ b/doc/auto_update.md @@ -1,5 +1,5 @@ -# Automatic Schema Updating - +Automatic Schema Updating +======== GitBucket uses H2 database to manage project and account data. GitBucket updates database schema automatically in the first run after the upgrading. To release a new version of GitBucket, add the version definition to the [servlet.AutoUpdate](https://github.com/takezoe/gitbucket/blob/master/src/main/scala/servlet/AutoUpdateListener.scala) at first. diff --git a/doc/comment_action.md b/doc/comment_action.md index fa99f8cfe..d5f2d39f1 100644 --- a/doc/comment_action.md +++ b/doc/comment_action.md @@ -1,5 +1,5 @@ -# About Action in Issue Comment - +About Action in Issue Comment +======== After the issue creation at GitBucket, users can add comments or close it. The details are saved at ```ISSUE_COMMENT``` table. diff --git a/doc/directory.md b/doc/directory.md index a18040d2d..27b4990b2 100644 --- a/doc/directory.md +++ b/doc/directory.md @@ -1,5 +1,5 @@ -# Directory Structure - +Directory Structure +======== GitBucket persists all data into __HOME/.gitbucket__ in default (In 1.9 or before, HOME/gitbucket is default). This directory has following structure: diff --git a/doc/how_to_run.md b/doc/how_to_run.md index 42536e3ee..bb14bbcfe 100644 --- a/doc/how_to_run.md +++ b/doc/how_to_run.md @@ -1,4 +1,5 @@ -# How to run from the source tree +How to run from the source tree +======== for Testers -------- diff --git a/doc/notification.md b/doc/notification.md index b2f6acecb..90a88bbb3 100644 --- a/doc/notification.md +++ b/doc/notification.md @@ -1,4 +1,5 @@ -# Notification Email +Notification Email +======== GitBucket sends email to target users by enabling the notification email by an administrator. diff --git a/doc/readme.md b/doc/readme.md index 354d70227..c89572786 100644 --- a/doc/readme.md +++ b/doc/readme.md @@ -1,10 +1,10 @@ -# Developer's Guide - +Developer's Guide +======== * [How to run from source tree](how_to_run.md) * [Directory Structure](directory.md) - * [Mapping and Validation](mapping_and_validation.md) - * [Authentication in Controller](authentication.md) - * [About Action in Issue Comment](comment_actionb.md) + * [Mapping and Validation](validation.md) + * Authentication in Controller (not yet) + * [About Action in Issue Comment](comment_action.md) * [Activity Types](activity.md) * [Notification Email](notification.md) * [Automatic Schema Updating](auto_update.md) diff --git a/doc/mapping_and_validation.md b/doc/validation.md similarity index 98% rename from doc/mapping_and_validation.md rename to doc/validation.md index bf66dab3c..69160fb7e 100644 --- a/doc/mapping_and_validation.md +++ b/doc/validation.md @@ -1,5 +1,5 @@ -# Mapping and Validation - +Mapping and Validation +======== GitBucket uses [scalatra-forms](https://github.com/takezoe/scalatra-forms) to validate request parameters and map them to the scala object. This is inspired by Play2 form mapping / validation. At first, define the mapping as following: