summaryrefslogtreecommitdiff
path: root/General
diff options
context:
space:
mode:
authorpriyankabhagwat2017-05-18 17:23:42 +0530
committerpriyankabhagwat2017-05-18 17:47:55 +0530
commit5cfac60d04944b5b25e59fe09e9e06f6efeb386c (patch)
tree5e6111ae90670f21a30543bdd3e1971ad2feb13d /General
parent70a384ffd7974d87bf7477fdbbf45acd1b2a9b0a (diff)
downloadwebsite-docs-5cfac60d04944b5b25e59fe09e9e06f6efeb386c.tar.gz
website-docs-5cfac60d04944b5b25e59fe09e9e06f6efeb386c.tar.bz2
website-docs-5cfac60d04944b5b25e59fe09e9e06f6efeb386c.zip
Directory structure change and various edits
Diffstat (limited to 'General')
-rw-r--r--General/Critical-analysis-FOSSEE-websites.rst115
-rw-r--r--General/Drupal6-Drupal7-upgrade-process.rst158
-rw-r--r--General/Drupal7-site-setup.rst46
-rw-r--r--General/Instruction-Sheet-develop-deploy-website.rst122
4 files changed, 441 insertions, 0 deletions
diff --git a/General/Critical-analysis-FOSSEE-websites.rst b/General/Critical-analysis-FOSSEE-websites.rst
new file mode 100644
index 0000000..dc8e2a6
--- /dev/null
+++ b/General/Critical-analysis-FOSSEE-websites.rst
@@ -0,0 +1,115 @@
+Document Information
+====================
+
+Name of the Document: Critical Analysis of FOSSEE Websites
+
+Date: 4/05/2017
+
+Author: Priyanka Bhagwat
+
+Designation: Software Engineer
+
+Introduction
+============
+
+This document aims to identify website features/modules that should be
+removed/improve and identifying bugs
+
+Assumptions
+===========
+
+It is assumed that the readers of this document are familiar with the
+Drupal 7, PHP, MySQL and software engineering. It is also assumed that
+the required resources will be available to achieve the objectives of
+the plan.
+
+Common Suggestions for all the websites
+=======================================
+
+Centralised login ( if possible)
+
+Search Engine Optimisation
+
+Standardise menu names and URL’s throughout all websites.
+
+Database structure to be standardized across all websites.
+
+Scilab Website
+==============
+
++-------+---------------------+
+| URL | http://scilab.in/ |
++=======+=====================+
++-------+---------------------+
+
+1. General Comments
+
+ a. Reduce content on website. Too much content on the site makes it
+ look bulky and hence many times other lightweight themes
+ cannot be implemented. Even too many links on the site. We can
+ come up with better way to display side navigations, Few
+ examples at
+ `*https://dcrazed.com/jquery-navigation-plugins-menus/* <https://dcrazed.com/jquery-navigation-plugins-menus/>`__
+
+ `*http://cssmenumaker.com/menu/modern-accordion-menu#* <http://cssmenumaker.com/menu/modern-accordion-menu#>`__
+
+ b. Git implementation to be done. Currently the completed books are save
+ on the server and its entry in database. On completed book
+ checkbox selection the files should be automatically be pushed to
+ GIT repo.
+
+2. Apache Solr Search
+
+ a. New searching techniques to be implemented.
+
+ `*https://wunder.io/blog/build-advanced-content-listings-with-apache-solr-search-api-facet-api/2012-04-20* <https://wunder.io/blog/build-advanced-content-listings-with-apache-solr-search-api-facet-api/2012-04-20>`__
+
+ b. Result display of search can be improved.
+
+ c. Sometimes cannot handle search limit, throws Indexoutofbound()
+ exception.
+
+3. Textbook Companion/Lab Migration
+
+ a. User dashboard according to each role
+
+ b. Improve mail functions.
+
+ c. The overall way how the data is displayed can be improved. Can use
+ flat UI.
+
+ `*http://bootsnipp.com/snippets/W7gNz* <http://bootsnipp.com/snippets/W7gNz>`__
+
+ d. Payment interface to be tested.
+
+4. Scilab Toolbox Interface
+
+ a. Currently, this content is added as static HTML. An interface to
+ be developed which will take data as input and render it to
+ the decided format. The parameters to be given by scilab team.
+
+5. Scilab on cloud
+
+ a. Currently the Categories loaded are written static. For future
+ scope this should also be loaded dynamically from the
+ database.
+
+FOSSEE Website
+==============
+
++-------+---------------------+
+| URL | http://fossee.in/ |
++=======+=====================+
++-------+---------------------+
+
+1. Statistics Module
+
+ a. The overall code written needs to be simplified and an standard
+ way to add new projects needs to be implemented. Currently the
+ process is quite complicated.
+
+2. Inventory System
+
+ a. We can add inventory system to the site where the office staff can
+ add details of hardwares and other stationery and can assign
+ to the FOSSEE Employees.
diff --git a/General/Drupal6-Drupal7-upgrade-process.rst b/General/Drupal6-Drupal7-upgrade-process.rst
new file mode 100644
index 0000000..1dd4e88
--- /dev/null
+++ b/General/Drupal6-Drupal7-upgrade-process.rst
@@ -0,0 +1,158 @@
+***Process to upgrade from drupal 6 to drupal 7***
+
+
+Document Information
+====================
+
+Name of the Document: Drupal 6 to Drupal 7 Upgradation process
+
+Date: 5/04/2015
+
+Author: Priyanka Bhagwat and Prashant Sinalakar
+
+
+**step 1:**
+
+**take a backup of your drupal site and database**
+
+**step 2:**
+
+**Login as superuser/first user and disable all custom modules and
+custom theme of drupal 6 site.**
+
+**step 3:**
+
+ 1) **Install drush into your system**
+
+ sudo apt-get install drush
+
+ 2) **Download latest version of drupal**
+
+ drush dl drupal-7
+
+ 3) **Connect your existing drupal 6 database with new drupal 7** (make
+ changes in setting.php of drupal 7 to connect with old database)
+
+ 4) **Go to project directory then run**
+
+ drush updb
+
+ 5) **Login in to drupal 7 as first user**
+
+ 6) **move all old site data to new drupal 7 expect theme**
+
+ 7) **remove modulename\_bck modules**
+
+ 8) **update all modules using**
+
+ drush dl -y acl references author\_pane ckeditor votingapi views ctools
+ references xmlsitemap webform advanced\_forum captcha cck ckeditor
+ comment\_notify email\_verify extlink feedback fivestar formblock
+ google\_analytics jquery\_ui jquery\_update link linkchecker masquerade
+ mimemail nice\_menus notify recaptcha spambot views
+
+ drush dl -y views date easy\_social captcha cck email\_verify sharethis
+ socila\_share wysiwyg google\_analytics jquery\_ui link masquerade
+ recaptcha
+
+ 9) enable all necessary modules
+
+ drush en module\_name
+
+ drush updb
+
+ if any error in webform take out webform form modules then,
+
+ **drush updb**
+
+ **drush command to update all modules without updating the core.**
+
+ drush upc --no-core
+
+**step 4:**
+ 1) drush dl drupal-7
+
+ 2) make settings.php
+
+ 3) connect with old db then, go to project dir run
+
+ # references, link
+
+ 4) drush updb
+
+ 5) login to first user and mv all old sites data to new d7 except theme,remove modulename\_bck modules, them update all modules using
+
+ drush dl -y acl references author\_pane ckeditor votingapi views ctools
+ references xmlsitemap webform advanced\_forum captcha cck ckeditor
+ comment\_notify email\_verify extlink feedback fivestar formblock
+ google\_analytics jquery\_ui jquery\_update link linkchecker masquerade
+ mimemail nice\_menus notify recaptcha spambot views
+
+ ## acl references views ctools references webform cck link views
+
+ 6) enable all necessary modules
+
+ 7) drush updb
+
+ 8) if any error in webform take out webform form modules then,
+
+ drush updb
+
+ node\_access => references
+
+**step 5:**
+
+ Scilink Query - Only for Scilab Website
+
+ content type => Documentation Page
+
+ select \* from content\_field\_link where nid in (SELECT nid FROM
+ \`content\_type\_link\` where \`field\_parent\_page\_nid\`=118)
+
+**Important**
+
+ 1) **changed query structure..**
+
+ 2) **theme\_table must be replaced to ‘Section title..
+===============theme(“”, “”, array =()) **
+
+***Error and solution :***
+
+ **If you get error like following: **
+
+ **“Undefined index: distribution\_name in
+ drupal\_install\_profile\_distribution\_name() (line 207 of
+ /var/www/html/drupal-7.37/includes/install.inc “**
+
+ **Then run following query in database**
+
+ `***UPDATE*** <http://dev.mysql.com/doc/refman/5.5/en/update.html>`__
+ `***system*** <http://localhost/adminer/adminer.php?username=root&db=anuduino_os_hardware_in&table=system>`__
+ **`*SET* <http://dev.mysql.com/doc/refman/5.5/en/string-type-overview.html>`__
+ status=1 WHERE name='standard';**
+
+ **This will resolve profile error**
+
+ **While going for changing query of theme**
+
+ theme('table', array('header' => $pending\_header, 'rows' =>
+ $pending\_rows ));
+
+ solve error of mail sending: email.inc change following line
+
+ change
+
+ **$language-language** replace with **array('language' =>
+ $language->language)**
+
+ **$message['body'] = t('…...’);** replace with **$message['body'] =
+ array('body' => t('…….));**
+
+ **Error:** *Notice*: Undefined index: distribution\_name in
+ *drupal\_install\_profile\_distribution\_name()* (line *207* of
+ */var/www/html/cfd\_fossee\_in\_7/includes/install.inc*).
+
+ FIX this:
+
+ UPDATE \`drupal\`.\`system\` SET \`status\` = '1' WHERE
+ \`system\`.\`filename\` = 'profiles/standard/standard.profile';
diff --git a/General/Drupal7-site-setup.rst b/General/Drupal7-site-setup.rst
new file mode 100644
index 0000000..956ba82
--- /dev/null
+++ b/General/Drupal7-site-setup.rst
@@ -0,0 +1,46 @@
+
+Document Information
+====================
+
+Name of the Document: Drupal 7 Site Setup
+
+Date: 5/04/2015
+
+Author: Priyanka Bhagwat and Prashant Sinalakar
+
+Prerequisite
+====================
+
+**Linux, Apache, MySql, PHP**
+
+Install Drush on system:
+
+sudo apt-get install drush
+
+`*http://www.drush.org/en/master/usage/* <http://www.drush.org/en/master/usage/>`__
+
+**Install php-5.6 Ubuntu 16.04**
+
+sudo add-apt-repository ppa:ondrej/php
+
+sudo apt-get update
+
+sudo apt-get install php5.6
+
+sudo apt-get install php5.6-mbstring php5.6-mcrypt php5.6-mysql
+php5.6-xml
+
+**GIT:**
+`*https://git-scm.com/book/en/v2/Getting-Started-Installing-Git* <https://git-scm.com/book/en/v2/Getting-Started-Installing-Git>`__
+
+**Drupal 7:**
+`*https://www.drupal.org/docs/7/system-requirements* <https://www.drupal.org/docs/7/system-requirements>`__
+
+**Drupal 7 Installation:**
+`*https://www.drupal.org/docs/7/install* <https://www.drupal.org/docs/7/install>`__
+
+**Custom Modules Drupal 7:**
+`*https://www.drupal.org/docs/7/creating-custom-modules* <https://www.drupal.org/docs/7/creating-custom-modules>`__
+
+**Clean URL Issue:**
+`*https://www.drupal.org/docs/7/configuring-clean-urls/enable-clean-urls* <https://www.drupal.org/docs/7/configuring-clean-urls/enable-clean-urls>`__
diff --git a/General/Instruction-Sheet-develop-deploy-website.rst b/General/Instruction-Sheet-develop-deploy-website.rst
new file mode 100644
index 0000000..844f76c
--- /dev/null
+++ b/General/Instruction-Sheet-develop-deploy-website.rst
@@ -0,0 +1,122 @@
+Document Information
+====================
+
+Name of the Document: Instruction sheet for developing and deploying new
+website
+
+Date: 16/05/2017
+
+Author: Priyanka Bhagwat
+
+Designation: Software Engineer
+
+Introduction
+============
+
+This document gives the steps involved while developing a new FOSSEE
+website.
+
+Assumptions
+===========
+
+It is assumed that the readers of this document are familiar with the
+Drupal 7, PHP, MySQL and software engineering. It is assumed that the
+DOCS mentioned in the file are already shared, if not found please
+contact the senior webteam member/Sysads/managers for the same.
+
+For any new website similar to Scilab Webiste
+
+Step 1: **General Requirements**
+
+1. **URL**: “domain” on main server
+
+2. **URL**: “domain” on test server eg “r.fossee.aero.iitb.ac.in
+
+3. **Contact Id**: contact-id(at)fossee(dot)in
+
+4. **Mailing List**: group mailing list for members for example
+ r(dot)fossee(dot)in
+
+5. **AWstats** and **Google analytics** for the same.
+
+Step 2: **On Local machine**
+
+1. Copy the latest working project directory and database from the main
+ server on your **local** machine
+
+2. Login as **superuser**
+
+3. Find and replace the existing name/email ids/contact-ids according
+ to the new project name.
+
+4. Follow step 3 for database tables as well
+
+5. Clean the database entries for custom modules and user table
+ **except the superuser**
+
+6. Create required directories for code uploads as per requirement
+
+7. Add necessary information to the TBC/LM settings for eg- CC, BCC,
+ contact ids etc
+
+8. Disable Captcha
+
+9. Add the **AWstats** and **Google analytics.** The details can be
+ viewed at “\ **FOSSEE WEBSITES STATISTICS SHEET**\ ” GDOC
+
+10. Test it locally.
+
+Step 3: **On Test Server**
+
+1. If testing is successful, ask Sysads to deploy it on **test server**
+
+2. Ask the respective team to test the site on test server
+
+3. Resolve errors, if any
+
+4. Ask the Sysads to deploy it to the main server
+
+Step 4: **On Main Server**
+
+1. Check if the Uploads folder is present
+
+2. Check for CAPTCHA and RECaptcha
+
+3. Create and Update new Superuser username and password and add it to
+ the “\ **Web Team Access**\ ” GDOC
+
+4. Test with dummy data, once OK clear the dummy data added
+
+5. Make the site available for use
+
+Step 5: FOSSEE Statistics
+
+1. FOSSEE Site statistics
+
+ a. Copy the php file from main server.
+ Location:/Sites/fossee\_drupal/data/project-statistics.php
+
+ b. Add the new website details to the file.
+
+ c. Update the file on the main server, assuming you have necessary
+ permissions.
+
+ d. The site stats can be view at
+ `*http://fossee.in/data/project-statistics.php* <http://fossee.in/data/project-statistics.php>`__
+
+2. FOSSEE Activity statistics
+
+ a. You need a working fossee.in copy on your local.
+
+ b. Either Fork or Clone the repo
+ `*https://github.com/FOSSEE/FOSSEE\_Stats* <https://github.com/FOSSEE/FOSSEE_Stats>`__
+
+ c. Add the new website database details to settings.php.
+
+ d. Make the necessary changes
+
+ e. Send pull request to the repo.
+
+ f. Pull the changes on test server.
+
+ g. If ok, ask sysads to merge the changes to the main server.