Browse Prior Art Database

A Methodology to Synchronize Technical Blog with Official Documentation

IP.com Disclosure Number: IPCOM000246936D
Publication Date: 2016-Jul-18
Document File: 6 page(s) / 155K

Publishing Venue

The IP.com Prior Art Database

Abstract

Technical peers often write blogs to share experience on specific topics (e.g. installing softwares, deploying services). As the involved technique will update after a period of time, these existing outdated blogs could, however, cause misunderstanding to the readers. In addition, in open source area, third-party documents are lack of maintenance as well. For example: A package build system for OS, there blogs introduce the installation process of it. However, several months ago, it replaced encryption method A with B due to the security issue. However, after this change, those outdated blogs still consider the default encrypt method without updating. This will lead to wrong configuration in it, which makes this package not able to work as normal.

In summary, technique is always updating itself, but the blogs sharing knowledge on it stays outdated, which makes blog readers not informed well. To solve the problem, we propose a methodology to synchronize technological blog with official documentation.

This text was extracted from a PDF file.
This is the abbreviated version, containing approximately 52% of the total text.

Page 01 of 6

A Methodology to Synchronize Technical Blog with Official Documentation
1. High level architecture of the synchronization methodology

1



Page 02 of 6


2. Detailed workflow

2



Page 03 of 6

3



Page 04 of 6


A. Authorization

Authorize Pulling service to catch target page and generate link on it


B. Pulling Service

Periodically check updates from technology official doc node/tutorial page

C. Extraction Service


Extract the key properties of the tutorial/official doc including "title", "timestamp" , "script/commands/configuration" and "known technology involved" Coverts these properties into key-value format


D. Synchronization Service

The service would compare the key value of doc properties, then generate link/sub-page/window on original tutorial page


3. Detailed Innovation Description

Server: a server which handles the services and the communications among the tech blog node and the official document nodes
Tech blog node: a web page that holds a technical blog, which introduces a step-by-step guide (e.g. a tutorial to deploy a specific software environment), involving software or computer technics
Official document node: the official document website of a specific technic, e.g. a software, a package, an operating system, a framework. etc.

The invention comprises of following steps:
1. The server, which manages the whole workflow and interacts with both the tech blog node and the official document nodes, gets authorization to access the content of the tech blog node, pull it from remote to local site, and update it. Also, it gets authorization to access and use the content of official document nodes. If a technic blog admin wants his/ her blog to be managed by the server, he/ she could launch a request, and grants the authorization to the server.


2. The server retrieves the content of the tech blog and the official documents. These static web pages are temporarily stored and wait for further processing. Also, the server periodically checks the official document nodes for updates, which often mean there are new updates in the related technics, such as version upgrade in a software. These updates are pulled and will be handled by following services.


3. The web page content, which is stored locally, is processed by the exraction service on the server. The content is analyzed and extracted to key-value

4



Page 05 of 6

format data.

For official documents, the web page data is extracted to: technic name, edition, and commands, which are composed of commands to check prerequisites, commands to install/ deploy the technics, and commands to do post-install operations.

For tech blogs, the web page data is extracted to: blog title, timestamp and technics involved. In addition, for each technic involved, following key-values are generated from the web page content: edition (aka. version) and commands, similarly, which comprises of commands to check prerequisites, commands to install/ deploy the technics, and commands to do post-install operations. For a ne...