From c2e20dcf7c8e4b1ae0ac8306bc18b5e5a7ef745f Mon Sep 17 00:00:00 2001 From: Rushabh Mehta Date: Tue, 11 Jun 2013 10:43:20 +0530 Subject: [PATCH] [docs] added README.md files for website, utilities --- utilities/doctype/address/README.md | 1 + utilities/doctype/contact/README.md | 1 + utilities/doctype/note/README.md | 1 + utilities/doctype/note_user/README.md | 1 + utilities/doctype/rename_tool/README.md | 1 + utilities/doctype/sms_log/README.md | 1 + utilities/page/markdown_reference/README.md | 1 + website/doctype/about_us_settings/README.md | 1 + website/doctype/about_us_team_member/README.md | 1 + website/doctype/blog_category/README.md | 1 + website/doctype/blog_post/README.md | 1 + website/doctype/blog_settings/README.md | 1 + website/doctype/blogger/README.md | 1 + website/doctype/company_history/README.md | 1 + website/doctype/contact_us_settings/README.md | 1 + website/doctype/style_settings/README.md | 6 ++++++ website/doctype/top_bar_item/README.md | 1 + website/doctype/web_page/README.md | 1 + website/doctype/website_script/README.md | 1 + website/doctype/website_settings/README.md | 1 + website/doctype/website_slideshow/README.md | 1 + website/doctype/website_slideshow_item/README.md | 1 + 22 files changed, 27 insertions(+) create mode 100644 utilities/doctype/address/README.md create mode 100644 utilities/doctype/contact/README.md create mode 100644 utilities/doctype/note/README.md create mode 100644 utilities/doctype/note_user/README.md create mode 100644 utilities/doctype/rename_tool/README.md create mode 100644 utilities/doctype/sms_log/README.md create mode 100644 utilities/page/markdown_reference/README.md create mode 100644 website/doctype/about_us_settings/README.md create mode 100644 website/doctype/about_us_team_member/README.md create mode 100644 website/doctype/blog_category/README.md create mode 100644 website/doctype/blog_post/README.md create mode 100644 website/doctype/blog_settings/README.md create mode 100644 website/doctype/blogger/README.md create mode 100644 website/doctype/company_history/README.md create mode 100644 website/doctype/contact_us_settings/README.md create mode 100644 website/doctype/style_settings/README.md create mode 100644 website/doctype/top_bar_item/README.md create mode 100644 website/doctype/web_page/README.md create mode 100644 website/doctype/website_script/README.md create mode 100644 website/doctype/website_settings/README.md create mode 100644 website/doctype/website_slideshow/README.md create mode 100644 website/doctype/website_slideshow_item/README.md diff --git a/utilities/doctype/address/README.md b/utilities/doctype/address/README.md new file mode 100644 index 0000000000..a4efda625f --- /dev/null +++ b/utilities/doctype/address/README.md @@ -0,0 +1 @@ +Address belonging to a Customer or Supplier. \ No newline at end of file diff --git a/utilities/doctype/contact/README.md b/utilities/doctype/contact/README.md new file mode 100644 index 0000000000..484522c1ba --- /dev/null +++ b/utilities/doctype/contact/README.md @@ -0,0 +1 @@ +Contact representing a Customer or Supplier. \ No newline at end of file diff --git a/utilities/doctype/note/README.md b/utilities/doctype/note/README.md new file mode 100644 index 0000000000..95d7b33269 --- /dev/null +++ b/utilities/doctype/note/README.md @@ -0,0 +1 @@ +Shared Note. (Page with standard information, links, attachments). \ No newline at end of file diff --git a/utilities/doctype/note_user/README.md b/utilities/doctype/note_user/README.md new file mode 100644 index 0000000000..a8e066d652 --- /dev/null +++ b/utilities/doctype/note_user/README.md @@ -0,0 +1 @@ +User who can access / edit the parent Note. \ No newline at end of file diff --git a/utilities/doctype/rename_tool/README.md b/utilities/doctype/rename_tool/README.md new file mode 100644 index 0000000000..38d408ce32 --- /dev/null +++ b/utilities/doctype/rename_tool/README.md @@ -0,0 +1 @@ +Tool to rename in bulk by uploading a .csv file. \ No newline at end of file diff --git a/utilities/doctype/sms_log/README.md b/utilities/doctype/sms_log/README.md new file mode 100644 index 0000000000..9ee2b79ef0 --- /dev/null +++ b/utilities/doctype/sms_log/README.md @@ -0,0 +1 @@ +Log of SMS sent via SMS Center. \ No newline at end of file diff --git a/utilities/page/markdown_reference/README.md b/utilities/page/markdown_reference/README.md new file mode 100644 index 0000000000..80f16cb4ec --- /dev/null +++ b/utilities/page/markdown_reference/README.md @@ -0,0 +1 @@ +Markdown reference. \ No newline at end of file diff --git a/website/doctype/about_us_settings/README.md b/website/doctype/about_us_settings/README.md new file mode 100644 index 0000000000..977a7a35e4 --- /dev/null +++ b/website/doctype/about_us_settings/README.md @@ -0,0 +1 @@ +Configuration for "About" page in the website that shows company, history and team. \ No newline at end of file diff --git a/website/doctype/about_us_team_member/README.md b/website/doctype/about_us_team_member/README.md new file mode 100644 index 0000000000..98b794f8d4 --- /dev/null +++ b/website/doctype/about_us_team_member/README.md @@ -0,0 +1 @@ +Details of team member for About Us page. \ No newline at end of file diff --git a/website/doctype/blog_category/README.md b/website/doctype/blog_category/README.md new file mode 100644 index 0000000000..af14b5dc14 --- /dev/null +++ b/website/doctype/blog_category/README.md @@ -0,0 +1 @@ +Blog category. \ No newline at end of file diff --git a/website/doctype/blog_post/README.md b/website/doctype/blog_post/README.md new file mode 100644 index 0000000000..63d3c0f31e --- /dev/null +++ b/website/doctype/blog_post/README.md @@ -0,0 +1 @@ +Blog post for "Blogs" section of website. \ No newline at end of file diff --git a/website/doctype/blog_settings/README.md b/website/doctype/blog_settings/README.md new file mode 100644 index 0000000000..0a76d4e261 --- /dev/null +++ b/website/doctype/blog_settings/README.md @@ -0,0 +1 @@ +Blog titles and introduction texts. \ No newline at end of file diff --git a/website/doctype/blogger/README.md b/website/doctype/blogger/README.md new file mode 100644 index 0000000000..13ddecda70 --- /dev/null +++ b/website/doctype/blogger/README.md @@ -0,0 +1 @@ +Profile of blog writer in "Blog" section. \ No newline at end of file diff --git a/website/doctype/company_history/README.md b/website/doctype/company_history/README.md new file mode 100644 index 0000000000..482c8d33d5 --- /dev/null +++ b/website/doctype/company_history/README.md @@ -0,0 +1 @@ +Company history detail for "About Us" section. \ No newline at end of file diff --git a/website/doctype/contact_us_settings/README.md b/website/doctype/contact_us_settings/README.md new file mode 100644 index 0000000000..61f589f796 --- /dev/null +++ b/website/doctype/contact_us_settings/README.md @@ -0,0 +1 @@ +Settings, introduction for "Contact Us" section. \ No newline at end of file diff --git a/website/doctype/style_settings/README.md b/website/doctype/style_settings/README.md new file mode 100644 index 0000000000..de9d0cd57f --- /dev/null +++ b/website/doctype/style_settings/README.md @@ -0,0 +1,6 @@ +Style settings for website. Includes settings for: + +- Site colours (background, toolbars) +- Fonts (family and size) +- Background (image if any) +- Custom CSS \ No newline at end of file diff --git a/website/doctype/top_bar_item/README.md b/website/doctype/top_bar_item/README.md new file mode 100644 index 0000000000..3300367c7d --- /dev/null +++ b/website/doctype/top_bar_item/README.md @@ -0,0 +1 @@ +Link in the header or footer of the website. \ No newline at end of file diff --git a/website/doctype/web_page/README.md b/website/doctype/web_page/README.md new file mode 100644 index 0000000000..1ef179b9e4 --- /dev/null +++ b/website/doctype/web_page/README.md @@ -0,0 +1 @@ +Static (HTML / JS / CSS) page created by the user for the website. \ No newline at end of file diff --git a/website/doctype/website_script/README.md b/website/doctype/website_script/README.md new file mode 100644 index 0000000000..65af2a13d2 --- /dev/null +++ b/website/doctype/website_script/README.md @@ -0,0 +1 @@ +Custom javascript to be appended at the end of the page. Used to include 3rd party tracking / analytics tools. \ No newline at end of file diff --git a/website/doctype/website_settings/README.md b/website/doctype/website_settings/README.md new file mode 100644 index 0000000000..8e654fca58 --- /dev/null +++ b/website/doctype/website_settings/README.md @@ -0,0 +1 @@ +Overall website settings. Including banners, items appearing in the top and bottom menus, tracking code for Google Analytics etc. \ No newline at end of file diff --git a/website/doctype/website_slideshow/README.md b/website/doctype/website_slideshow/README.md new file mode 100644 index 0000000000..e6afaed16e --- /dev/null +++ b/website/doctype/website_slideshow/README.md @@ -0,0 +1 @@ +Image slide show for Web Page, Product (Item) page, Item Group page. \ No newline at end of file diff --git a/website/doctype/website_slideshow_item/README.md b/website/doctype/website_slideshow_item/README.md new file mode 100644 index 0000000000..2f52d24794 --- /dev/null +++ b/website/doctype/website_slideshow_item/README.md @@ -0,0 +1 @@ +Slide (image) details for Website Slideshow. \ No newline at end of file