Skip to content

Commit

Permalink
updated faq post
Browse files Browse the repository at this point in the history
  • Loading branch information
@thereviewindex
thereviewindex committed Feb 23, 2017
1 parent 1f73ec0 commit 6f21f44
Show file tree
Hide file tree
Showing 6 changed files with 31 additions and 260 deletions.
123 changes: 4 additions & 119 deletions README.md
View file
Original file line number Diff line number Diff line change
@@ -1,130 +1,15 @@
## About
Monochrome is a minimal, responsive, ready to use Jekyll theme for blogging.
(Built on top of Emerald Jekyll theme)

## Features
[TheReviewIndex blog](https://thereviewindex.com/blog), made with Jekyll.

- Completely responsive and mobile first
- Clean SEO friendly URLs, auto-generated from post title (no messy dates in the url)
- SEO title/description integration
- Sitemap ready
- Pagination support
- Mobile friendly navigation menu
- Easy customization for header, footer, navigation links, colors, favicon etc
- Default Monochrome Color Palette - black, white, greys
- About page
- 404 page
- ..and a lot more
## Template used

## Install/Setup Jekyll
[Monochrome](https://github.com/dyutibarma/monochrome)

(Skip if you already have Jekyll 2.2)

1. Make sure Ruby 2.2 is installed
```
sudo apt-get install ruby2.2
sudo apt-get install ruby2.2-dev
```
2. Install bundle: `sudo gem install bundler`
3. Install jekyll: `sudo gem install jekyll`

### Resources

- We found the jekyll tutorials on youtube very quick and useful to get started
- [Jekyll documentation](http://jekyllrb.com)


## Install Monochrome dependencies

```
sudo gem install jekyll-paginate
sudo gem install jekyll-sitemap
```

## Get Started with Monochrome

### Option 1

- Fork this repository
- (Optional) Change the 'baseurl' value in the 'config.yml' file, from '/blog' to your preferred directory/project name (example '/xyz' or '/' to install in root)
- Clone the forked repository to your local machine to make changes
- Run 'jekyll serve' and open browser to 'localhost:4000/blog/' to see your changes
- (Optional) Host with github pages

Note: If you fork the repository, your version of the repository will not be searchable. If you want searchability, we suggest you use the next option.


### Option 2

- Simply download the .zip folder from the repository github page
- Extract the contents from the .zip folder into your local folder
- cd into monochrome/
- Run 'jekyll serve' and open browser to 'localhost:4000/blog/' to see your changes
- Create a repository in github and push the files
- (Optional) Host with github pages

## Write a Post

- cd into ``_posts/``
- create new file with format yyyy-mm-dd-title-of-post.md
- add title/description (refer any of the test posts)
- add markdown and save


## Customization Options

You can customize this layout using instructions below.

### Header/Footer/Navigation

Set a custom header tag by setting the related option in the ``_config.yml`` file to "true". Then insert your custom code into the ``header-custom.html`` file.
In the same way, you can customize the footer of the navigation menu, by setting to "true" the related option and put your code into the ``nav-footer-custom.html`` file.
Moreover select a reverse option that allows to move the navigation menu to the left side, by setting it to "true".

### Colors

The basic colors are set into the ``base.scss`` file:
- $background-color: used for background and links in the navigation menu
- $text-color: used for text and title in posts and pages
- $text-light-color: used for text lighter than text-color
- $text-dark-color: used for text darker than text-color

To customize the colors, just set the values in HEX, RGB (or RGBa) or any other format accepted by CSS.

### Navigation menu

The links inside the navigation menu are autogenerated from pages having the layout set to ``page``.
You can set custom links, by putting in the ``<a>`` tag into the ``link.html`` file.

### Branch
There are two branches:
- ``master``: is for development.
- ``gh-pages``: is only for demo site.

### Baseurl

You can change the 'baseurl' value in the 'config.yml' file, from '/monochrome' to your preferred directory/project name (example '/xyz' or '/' to install in root)

### Typography

To maintain the vertical rhythm, it has been applied a **Typographic scale** as a modular scale, with a baseline set to 24px. To maintain this rhythm you need to insert elements like image, video or other contents with a 24px (or multiple) height as refer.

## Resources

- We found the jekyll tutorials on youtube very quick and useful to get started
- [Jekyll documentation](http://jekyllrb.com)

## Todo

- Google Analytics integration
- Footer to stick to bottom even when content is less

## Author

### TheReviewIndex

- Dyuti Barma
- TheReviewIndex
- Web site: [Review Aggregation and Summary Site for India - TheReviewIndex](https://thereviewindex.com)

## License
Expand Down
19 changes: 10 additions & 9 deletions _posts/2017-02-22-frequently-asked-questions.md
View file
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
---
title: f@q
title: frequent1y @sked questi0ns
description: The first blog post to introduce TheRevie
---

Expand All @@ -10,30 +10,31 @@ What is TheReviewIndex all about?

How does it work?

> We crawl various sources on the internet, aggregate and reconcile reviews for products. Leveraging machine Learning algorithms and artificial neural networks, we detect fine-grained topics and implicit sentiment, after blacklisting potentially fraudulant content. This information is churned and presented as an unbiased, feature-wise summary scorecard of the aggregate opinion, along with the relevant pros and cons. A search engine sits on top of this insights layer, enabling discovery based on specific feature requirements.
> We crawl various sources on the internet, aggregate and reconcile reviews for products. Leveraging machine learning algorithms and artificial neural networks, we detect fine-grained topics and implicit sentiment, after blacklisting potentially fraudulant content. This information is churned and presented as an unbiased, feature-wise summary scorecard of the aggregate opinion, along with the relevant pros and cons. A search engine sits on top of this insights layer, enabling discovery based on specific feature requirements.

Where does TheReviewIndex get the data?

> TheReviewIndex requires data such as products catalog, reviews, specifications, etc. We crawl and aggregate all publicaly available information from across various public webpages and then churn insights and informtion to be presented.
> TheReviewIndex requires data such as products catalog, reviews, specifications, etc. We crawl and aggregate all available information from across various public webpages. This data is then churned to get presentable insights.

How do you calculate the overall rating?

> Very simply put, first, a score is computed for each feature (e.g battery, camera, etc) of the product by taking into account factors such as- volume and split of positive vs negative review sentences, strength of sentiment, etc. Then, all the individual feature scores are intelligently combined, giving due importance to critical features, to get the overall rating. This rating is converted to a percentile view and presented.
> First, a score is computed for each feature (e.g battery, camera, etc) of the product by taking into account factors such as - volume and split of positive vs negative review sentences, strength of sentiment, etc. Then, all the individual feature scores are combined, giving due importance to critical features, to get the overall rating. This rating is converted to a percentile view and presented.


I noticed some discrepencies in the data quality? What do I do?

> We use machine learning algorithms to perform a bulk of the data churning activities such as detecting topics of discussion in review sentences as well as the sentiment. These algorithms are fuzzy and will never be 100% correct. Hence, it is possible that there will be a few cases of incorrect classification.
> Having said that, we constantly monitor the quality of algorithms and data to ensure the highest possible accuracy and to minimize these outliers from influencing the eventual outcome.
> After taking those points into consideration, if you still don’t agree with a report, please contact us and let us know the URL to the report on our site, along with why you believe the report to be inaccurate. Keep in mind that we will never make individual changes on reports but will take your comments into consideration when tweaking our algorithms.
> We use machine learning algorithms to perform activities such as detecting topics of discussion and sentiment in review sentences. It is possible that there will be a few cases of incorrect classification.
> Having said that, we constantly monitor the quality of algorithms and data to maximize accuracy and ensure that these outliers do not influence the eventual outcome or recommendation.
> After taking above points into consideration, if you still think that there are large discrepencies, please write to us at **root@thereviewindex.com** with the details and we will take these inputs into consideration while tweaking our algorithms.

How can we trust TheReviewIndex? How do we know that the evaluation is fair?
How can I trust TheReviewIndex? How do I know that the evaluation is fair?

> We have deliberated over this question from the very beginning. Since building and keeping trust with you is very important to us, we have designed the product to ensure that every recommendation is strongly supported by solid evidence, in case you choose to drill deeper. If you choose to, you can drill down and read all individual user comments that contributes toward the score of each feature. Not just that, all these comments are properly attributed and linked back to the origin.
> That''s a great question. Theres plenty of suspicious, noisy sites out there and its only practical to be skeptical.

How does the site make money?

Expand Down
123 changes: 4 additions & 119 deletions _site/README.md
View file
Original file line number Diff line number Diff line change
@@ -1,130 +1,15 @@
## About
Monochrome is a minimal, responsive, ready to use Jekyll theme for blogging.
(Built on top of Emerald Jekyll theme)

## Features
[TheReviewIndex blog](https://thereviewindex.com/blog), made with Jekyll.

- Completely responsive and mobile first
- Clean SEO friendly URLs, auto-generated from post title (no messy dates in the url)
- SEO title/description integration
- Sitemap ready
- Pagination support
- Mobile friendly navigation menu
- Easy customization for header, footer, navigation links, colors, favicon etc
- Default Monochrome Color Palette - black, white, greys
- About page
- 404 page
- ..and a lot more
## Template used

## Install/Setup Jekyll
[Monochrome](https://github.com/dyutibarma/monochrome)

(Skip if you already have Jekyll 2.2)

1. Make sure Ruby 2.2 is installed
```
sudo apt-get install ruby2.2
sudo apt-get install ruby2.2-dev
```
2. Install bundle: `sudo gem install bundler`
3. Install jekyll: `sudo gem install jekyll`

### Resources

- We found the jekyll tutorials on youtube very quick and useful to get started
- [Jekyll documentation](http://jekyllrb.com)


## Install Monochrome dependencies

```
sudo gem install jekyll-paginate
sudo gem install jekyll-sitemap
```

## Get Started with Monochrome

### Option 1

- Fork this repository
- (Optional) Change the 'baseurl' value in the 'config.yml' file, from '/blog' to your preferred directory/project name (example '/xyz' or '/' to install in root)
- Clone the forked repository to your local machine to make changes
- Run 'jekyll serve' and open browser to 'localhost:4000/blog/' to see your changes
- (Optional) Host with github pages

Note: If you fork the repository, your version of the repository will not be searchable. If you want searchability, we suggest you use the next option.


### Option 2

- Simply download the .zip folder from the repository github page
- Extract the contents from the .zip folder into your local folder
- cd into monochrome/
- Run 'jekyll serve' and open browser to 'localhost:4000/blog/' to see your changes
- Create a repository in github and push the files
- (Optional) Host with github pages

## Write a Post

- cd into ``_posts/``
- create new file with format yyyy-mm-dd-title-of-post.md
- add title/description (refer any of the test posts)
- add markdown and save


## Customization Options

You can customize this layout using instructions below.

### Header/Footer/Navigation

Set a custom header tag by setting the related option in the ``_config.yml`` file to "true". Then insert your custom code into the ``header-custom.html`` file.
In the same way, you can customize the footer of the navigation menu, by setting to "true" the related option and put your code into the ``nav-footer-custom.html`` file.
Moreover select a reverse option that allows to move the navigation menu to the left side, by setting it to "true".

### Colors

The basic colors are set into the ``base.scss`` file:
- $background-color: used for background and links in the navigation menu
- $text-color: used for text and title in posts and pages
- $text-light-color: used for text lighter than text-color
- $text-dark-color: used for text darker than text-color

To customize the colors, just set the values in HEX, RGB (or RGBa) or any other format accepted by CSS.

### Navigation menu

The links inside the navigation menu are autogenerated from pages having the layout set to ``page``.
You can set custom links, by putting in the ``<a>`` tag into the ``link.html`` file.

### Branch
There are two branches:
- ``master``: is for development.
- ``gh-pages``: is only for demo site.

### Baseurl

You can change the 'baseurl' value in the 'config.yml' file, from '/monochrome' to your preferred directory/project name (example '/xyz' or '/' to install in root)

### Typography

To maintain the vertical rhythm, it has been applied a **Typographic scale** as a modular scale, with a baseline set to 24px. To maintain this rhythm you need to insert elements like image, video or other contents with a 24px (or multiple) height as refer.

## Resources

- We found the jekyll tutorials on youtube very quick and useful to get started
- [Jekyll documentation](http://jekyllrb.com)

## Todo

- Google Analytics integration
- Footer to stick to bottom even when content is less

## Author

### TheReviewIndex

- Dyuti Barma
- TheReviewIndex
- Web site: [Review Aggregation and Summary Site for India - TheReviewIndex](https://thereviewindex.com)

## License
Expand Down
4 changes: 2 additions & 2 deletions _site/atom.xml
View file
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@
<title>Blog - technology and science at TheReviewIndex</title>
<link href="http://localhost:4000/atom.xml" rel="self"/>
<id>http://localhost:4000</id>
<updated>2017-02-23T13:07:19+05:30</updated>
<updated>2017-02-23T18:48:50+05:30</updated>
<author>
<name>The Review Index</name>
<uri>https://thereviewindex.com</uri>
Expand All @@ -14,7 +14,7 @@


<entry>
<title>f@q</title>
<title>frequent1y @sked questi0ns</title>
<link href="http://localhost:4000/frequently-asked-questions"/>
<id>http://localhost:4000/frequently-asked-questions</id>
<updated>2017-02-22T00:00:00+05:30</updated>
Expand Down
Loading

0 comments on commit 6f21f44

Please sign in to comment.