Child pages
  • Blog - Magento 2
Skip to end of metadata
Go to start of metadata

Icon

FireFox user notice:

Please use different web-browser for viewing this document.

Sorry for the incoivenenice.

Blog - Magento 2

Thank you for choosing aheadWorks!


 

Installing Blog

To install the extension follow the instructions below:

1. Backup your web directory and store database;

2. Download Blog installation package;

 3. Upload contents of the Blog installation package to your store root directory;

 4. Navigate to your store root folder in the SSH console of your server:

cd path_to_the_store_root_folder

run:

php -f bin/magento module:enable Aheadworks_Blog

then:

php -f bin/magento setup:upgrade

after:

php -f bin/magento setup:static-content:deploy

5. Flush store cache; log out from the backend and log in again.

Icon

Make sure the installation is done from under the FTP administrator account. Otherwise make sure to set 775 permissions to the store root directory after the extension is deployed.

 

 

Registering Disqus

Blog extension by aheadWorks uses Disqus service to process and manage blog comments. Along with the comment management enhancements Disqus allows defining if guest customers can comment on the blog posts, open a discussion at Disqus forums, and serves as another social platform for your store advertising.

1. Create an account at Disqus;

 Click to view details

a) Proceed to Disqus website;

b) Click button in the upper right corner of the screen to proceed to the registration form.

You can create an account with one of your social networks account or register via the email. If registering via the email address, - don't forget to check for the 'Confirm email' message from Disqus team after registration.

2. Register new application;

 Click to view details

a) Proceed to the API Resources page and click button;

Decide on the Application Label, Description, your Organization name and Website. These are used for the Application identification purposes.

Once done, - click button. The application has been created.

b) Once again navigate to API Resourses page and copy the newly created application Secret Key;

Under Application section you can now see the newly created Application. Copy the application Secret Key and paste in into the Disqus Secret Key field of the Blog extension General Settings.

c) The Secret Key is now set and it's time to click 'Admin' link to proceed to adding a site to Disqus.

3. Add new site;

 Click to view details

 

a) Proceed to Your Sites block at the top of the page and click button;

b) Decide on the Website name, copy Unique Disqus URL from below the Website Name(where you will manage the blogcomments) and choose Category (optional)

Paste the Unique Disqus URL to the Disqus Forum Code field of the Blog extension General Settings.

c) Once done, - click button.

Icon

Please note, the Website name you enter will be displayed as above the Comments section of the blog posts:

4. Configure comment policies.

 Click to view details

a) After adding new site navigate to the Settings section;

b) Proceed to Community tab:

  • Guest Commenting - decide if you want to allow guest customers to leave comments;
  • Pre-moderation - decide if you want to manually approve all the comments;
  • Links in Comments - decide if you want to manually approve only the comments containing links;
  • Media Attachments - decide if you want to let your customers to attach images and videos to comments;
  • Flagged Comments - decide about the notifications on customer reported comments;
  • Automatic Closing - decide if you want a blog post to become unavailable for comments after set number of days;

c) You may also want to look through the other settings available. Once done, - click button at the bottom of the page.

Icon

We are not providing assistance with setting up the Disqus services.

If you have any questions or require assistance with additional settings refer to the Disqus knowledge base.

 

 

Migrating from Blog for Magento 1

What one should know before migrating Aheadworks Blog for M1 to Blog for M2?

Icon

Read carefully and consider this information of top priority as otherwise it may result in an accident data loss.

  1. Magento Data Migration Tool is required to be installed prior to starting migration.
    The migration script relies heavily on Magento Data Migration tool. Understanding how it works will prove useful during migration process.
  2. Backup Magento 2 databases before migration to have an opportunity to revert any changes.
    Blog migration may involve rewriting database tables, backup is advised.
  3. Blog post images cannot be migrated automatically and should be migrated manually for best results.
    More information on migrating images can be found in the Magento instructions on manual migration.
  4. All widget references incusing CMS blocks should be migrated manually.
  5. Pay close attention to <aw_blog_updates> tag value you enter if you already have posts on your Magento 2 store and want to keep them.
    "0" value set by default will overwrite all existing Magento 2 Blog posts, "1" value will add new post entries to the existing ones.

Video guide

Migration process is highlighted in the education Video Guide at Aheadworks Youtube channel. However, we still advise to read through the instructions below to make sure you haven't missed anything.

Don't forget to enable subtitles in the video to follow the data migration process.

Migration process

Down below is a written migration guide with more detailed steps description.

 1. Log into your Magento server as file owner and navigate to the directory you have your Magento 2 store installed

 Click to view details

For example:

cd /var/www/my_magento2_store/

2. Install Magento Data Migration Tool

 Click to view details

Installation instructions for Magento Data Migration Tool along with basic information can be found here: http://devdocs.magento.com/guides/v2.0/migration/migration-tool-install.html

Magento provides two ways of installing Magento Data Migration Tool:

For the demo video purposes we have been installing Data Migration Tool from GitHub.

After you may want to navigate to vendor/magento/ to make sure the Migration Tool has been installed successfully.


 3. Download Blog migration distributive and unpack it to the desired location

 Click to view details

Blog migration distributive can be downloaded by the link here: https://s3.amazonaws.com/aheadworks_cdn/Blog/data-migration-tool.zip

Unpack the contents of the distributive to find /etc and /scr folders inside.

 4. Copy the contents of Blog migration distributive to Magento Data Migration Tool main folder

 Click to view details
Copy /etc and /scr folders found in the Blog migration package to: vendor/magento/data-migration-tool/

Rewrite on prompt.

 5. Edit config.xml file of the Magento Data Migration Tool

 Click to view details
Navigate to vendor/magento/data-migration-tool/etc/aw_blog/ and open config.xml for edit.
More information on the tag values and what one should put inside can be found in the Magento Data Migration Tool configuration instructions.

 

Icon

Pay close attention to <aw_blog_updates> tag value you enter if you already have posts on your Magento 2 store and want to keep them.
"0" value set by default will overwrite all existing Magento 2 Blog posts, "1" value will add new post entries to the existing ones.

 6. Run migration script in the console

 Click to view details

Run the following command considering path to the config.xml to start migration:

bin/magento migrate:data [-r|--reset] {<path to config.xml>}

In the demo video we are using the following command considering path to config.xml:

bin/magento migrate:data -r vendor/magento/data-migration-tool/etc/aw_blog/config.xml

 7. Data migration is complete. Make sure to migrate images and widget related items manually

8. Once migration is complete Blog extension will create new database tables, marking the obsolete ones with the _old postfix.

 Click to view details

After you make sure the migration was a success you may want to remove old database tables:

DROP TABLE IF EXISTS `aw_blog_cat_old`;
DROP TABLE IF EXISTS `aw_blog_cat_store_old`;
DROP TABLE IF EXISTS `aw_blog_post_old`;
DROP TABLE IF EXISTS `aw_blog_post_cat_old`;
DROP TABLE IF EXISTS `aw_blog_post_store_old`;
DROP TABLE IF EXISTS `aw_blog_post_tag_old`;
DROP TABLE IF EXISTS `aw_blog_tag_old`;


Getting started

Once you are finished with installing the extension and registering Disqus application it is high time to proceed to your Magento 2 backend to finalize the Blog setup.

Before creating your first blog post we suggest running through the Blog extension settings and other options available to adjust the blog look and behavior. This will help in better understanding of how the extension functions and what can you expect your posts to look and feel like.

 

The fist step is to apply Disqus Forum Code and Secret Key at the General Settings section of the extension to finalize the installation.

General Settings


Stores > Configuration > aheadWorks extensions > Blog

This configuration section reflects the Blog functional aspects. These are the settings that affect the blog accessibility, content layout and other.

Here you have an access to the following configuration options:

  • Enabled - defines is the Blog is enabled on the store;

  • Route to Blog - defines the direct link to the main blog page of your store e.g. store.com/myblog;

  • Blog Title - defines the name of the blog page; either you want to add your company name or change the title completely, - feel free adjusting this field as you feel;

  • Posts per page - defines how many posts will be displayed per blog page;

  • Display Sharing Buttons At - defines where the social network sharing buttons should be displayed at;

  • Comments enabled - defines if customers can comment blog posts;
  • Disqus Forum Code - paste here the Disqus URL from the step 3 of Disqus setup;

  • Disqus Secret Key - paste here the Disqus Secret Key from the step 2 of Disqus setup.

You have just configured the main blog page and access to it. Now we suggest proceeding to adjusting the Blog sidebar and SEO.

Stores > Configuration > aheadWorks extensions > Blog

Sidebar

This configuration section reflects the Blog sidebar functional aspects. These settings define the post tags look, let you add a CMS block and configure the recent posts to display.

Here you have an access to the following configuration options:

  • Number of Recent Posts to Display - defines how many most recent blog posts should be displayed in the blog sidebar;
  • Number of Most Popular Tags to Display - defines how many popular tags should be displayed in the tag cloud of the blog sidebar;
  • Highlight Popular Tags - defines if the most popular tags should be highlighted with bold or with increased font size;
  • Sidebar CMS Block - allows chosing a CMS block to be displayed in the blog sidebar.
Icon
 Click here to see how the sidebar looks like...

SEO

Below the Sidebar configuration block you can find SEO configuration with a single filed Blog Meta Description. At this field you are suggested to type in few words for SEO identification of your Blog.

Related Products

Stores > Configuration > aheadWorks extensions > Blog

Starting from 2.0 version of Blog extension, store administrator can add related product blocks to the blog post pages. In addition, Blog tab is added to the product pages. Under the 'Blog' tab customers can find blog articles where this particular product has been mentioned as related.

This configuration section defines how the related product blocks that can be assigned to the blog posts should behave:

  • Display Blog Posts Tab on Product Page - defines if the 'Blog' tab should be displayed at product pages;
  • Display Related Products Block on Post Page - defines if and where the related products block should be displayed at the blog post page;
  • Related Products Block Layout - defines the related product block's layout;
  • Display "Add to Cart" Button - defines if 'Add to Cart' button should be displayed on the products featured in the related product blocks at blog post pages.

Once done with the settings click button.

Before continuing to creating your first blog post there is one other thing to consider - blog categories.

Wordpress Import

Stores > Configuration > aheadWorks extensions > Blog

Starting from 2.2.0 version of Blog extension, store administrator can import blog posts from wordpress blog.

The process behind migration is the following:

  1. Navigate to Tools > Export in the Wordpress administrator area;
  2. Choose 'Posts' option and click 'Download export file' button. An XML file containing all blog posts should be downloaded;
  3. Navigate to your Magento backend Stores > Configuration > aheadWorks extensions > Blog;
  4. In the 'Wordpress Import' section of the Blog settings upload XML file via 'Import file';
  5. Set 'Override existing posts with the same URL' if you want the existing Magento 2 posts with the same URL overridden;
  6. Click 'Import Posts' button to begin post import;
  7. If imported successfully copy contents from Wordpress folder:
    wp-content/uploads/ 
    directly to Magento folder:
    /pub/media/wp-content/uploads/
    If this directory doesn't exist - create it manually. Make sure the file permissions are set properly.

Post migration is now complete.

Blog Categories

Content > Blog by aheadWorks > Categories

Blog Categories represent another navigation tool your customers may find helpful. Along with providing a navigation tool, categories ease the post management and let you highlight the post's theme.

Click button to add the first blog category to your store. Once at the New Category page decide on the following:

The configuration is pretty much straightforward with the options names speaking for themselves.

Now, when we are done with configuring the extension it is time to create your first blog post.

 


The First Post

This is it. To create your first post navigate to Content > Blog by aheadWorks > New Post this will land you directly at the New Post form.

The New Post form is quite huge that is why for further convenience we will split it in three steps:

Step 1: title, URL key, schedule

 

At this step you are suggested to:

  • Type in the blog post title that will be visible at the top of it;
  • Decide on the post's URL key;
  • Schedule the to post the draft automatically at a time set.
Icon

Scheduling a post can prove useful in different situations:

  • Start of the sale;
  • New product/service release;
  • Holiday greeting;
  • etc.

With the scheduling functionality you can chose on what date, hour and event second you want the draft to be published.

Whenever you tick Schedule Post box appears at the top of the page. Once you are done with the post click it and the post is scheduled.

 Click to see how the scheduler looks like...

Step 2: short content, categories, tags

 

At step 2 you are suggested to decide if your post should have a Short Content, set the post to particular category and decide on tags.

Short Content can prove usefull if your post is content heavy and takes a couple of pages. What it does is instead of displaying whole post on a Blog page it allows displaying only the contents of the Short Content field, thus saving blog page space and making it look neat.

Icon
 Click to see how the post looks like with and without short content...

Without Short Content field enabled:

With Short Content field enabled:

 

Tags are one of the navigations tools provided by Blog extension. Every post is suggested to be tagged with relevant words or phrases to simplify further customer search for relevant information. All the tags are gathered in a tag cloud displayed at the blog Sidebar.

Icon
 Click to see how the tags work...

The more particular tags you have the more highlighted they become. At an image above we have five tags: post, lorem ipsum, first, Grand opening, test store.

The 'post' tag has been used in three posts in our blog, all the other tags were used only once. As you can see from the tag cloud 'post' tag ourshines the others.

 

Step 3: content, comments, meta description

 

At the final step you are suggested to type in the blog contents, meta description and decide if you want your customers to comment on the post.

Content field column comes with native Magento WYSIWYG editor allowing text editing, inserting images, widgets, variables etc.

 

That's it. Providing you are done with all three steps you can now click button and your first blog post is ready.

 


Commenting and Sharing

Once you have blog posts going your customers will probably want to leave their opinion and comment on different topics. To handle customer comments Blog extension introduses Disqus forums functionality.

"Disqus is a networked community platform used by hundreds of thousands of sites all over the web", meaning your Blog content can potentially be interesting to people over the internet promoting your store.

 

 

Here how the post will be represented to your customers.

  • Social network sharing buttons - available right after installation and do not require additional setup;
  • Tags - are clickable allowing quick blog navigation;
  • Blog post category - represents a category of the post (store only);
  • Disqus account login - lets your customers log into the Disqus forums;
  • Disqus forum name and link - navigates to your store forum at Disqus.

How to comment

In order to comment, customers will need to have a Disqus account or log in via: Facebook, Twitter or Google+. Once logged in, customers can leave comments and enter any open discussions on Disqus.

Clicking Disqus forum name customers are redirected to the corresponding Disqus forum of your store. Here all active blog posts will be represented as different forum topics customers can join.

 

 

Customers can like, share, flag and reply to comments. Every customer action is respectively reflected at the Blog page of your store.

Managing comments

As a store administrator you can manage all the customer comments to your blog posts.

 

Content > Blog by aheadWorks > Comments

The comment management takes place at the Disqus side.

Here you can: approve, mark as spam and delete comments; along with managing the Disqus forum settings.

More information on how to manage the comments and set up Disqus per your requirements can be found in the Disqus knowledge base.

 


You can always find the latest version of the software, full documentation, demos, screenshots and reviews at http://ecommerce.aheadworks.com
License agreement: http://ecommerce.aheadworks.com/LICENSE-M1.txt
Contact Us: http://ecommerce.aheadworks.com/contacts/
Copyright © 2015 aheadWorks Co. http://www.aheadworks.com

  • No labels