A method and device for upgrading product documents

Abstract

The embodiment of the present application discloses a method and device for upgrading product documents, which includes the following steps: after the product service is privately deployed to the customer's local area, the product document metadata corresponding to the customer's identity information is pulled through the product service according to the customer's unique identity identifier; the product document metadata is parsed through the product service, and data is initialized in the private deployment environment according to the parsing result, and the document station page is dynamically rendered according to the initialization data. Based on the mapping relationship between the product version metadata and the product document metadata, the embodiment of the present application realizes the initialization of the document content in two ways, online and offline, so that the product version is consistent with the document version, and no additional version control tools are required, and the private deployment process is more lightweight.

Description

Technical Field

[0001] The present application belongs to the field of computer technology, and specifically relates to a method and device for upgrading product documents. Background Art

[0002] In SAAS (Software-as-a-Service) enterprises, product documentation is a bridge connecting products and users, and the corresponding product documentation is also an indispensable pillar. When users trust the product, they also trust the documentation. Therefore, in the scenario of private deployment of SAAS platforms, the version matching consistency of products and documents is an absolute goal to pursue.

[0003] In the prior art, the multi-version management of document sites generally uses third-party open source tools, such as GitLab, as a version control tool, and implements multi-version management, automation, and document display of product documents based on the combination of GitLab's webhook event callback mechanism + page rendering engine. However, when cloud products are privately deployed locally, customers do not have the conditions to install GitLab locally, and cannot effectively ensure the version matching consistency of products and documents, which also brings more operation and maintenance costs.

[0004] Application Contents

[0005] The purpose of the embodiments of the present application is to provide a method and device for upgrading product documents to solve the defect that the prior art cannot effectively ensure the version matching consistency between the product and the document.

[0006] In order to solve the above technical problems, this application is implemented as follows:

[0007] In a first aspect, a method for upgrading a product document is provided, comprising the following steps:

[0008] After the product service is privately deployed locally on the customer, the product document metadata corresponding to the customer identity information is pulled through the product service according to the customer's unique identity identifier;

[0009] The product document metadata is parsed through the product service, and data is initialized in a private deployment environment according to the parsing result, and the document site page is dynamically rendered according to the initialization data.

[0010] In a second aspect, a device for upgrading product documents is provided, comprising:

[0011] A pulling module is used to pull product document metadata corresponding to the customer identity information through the product service according to the customer identity unique identifier after the product service is privately deployed to the customer's local area;

[0012] The parsing module is used to parse the product document metadata through the product service, and initialize data in the private deployment environment according to the parsing result, and dynamically render the document site page according to the initialization data.

[0013] The embodiment of the present application realizes online automatic initialization of document content based on the mapping relationship between product version metadata and product document metadata, so that the version of the product and the document match consistency, and no additional version control tools are required, making the private deployment process more lightweight. When the customer does not have the conditions for external network access locally, the ability to initialize product document metadata offline can be realized by importing database scripts. BRIEF DESCRIPTION OF THE DRAWINGS

[0014] Figure 1 It is a flow chart of a method for upgrading a product document provided in an embodiment of the present application;

[0015] Figure 2 It is a flow chart of obtaining product document metadata from a cloud product service maintenance platform in a private deployment environment provided in an embodiment of the present application;

[0016] Figure 3 It is a structural diagram of a product document upgrade device provided in an embodiment of the present application. DETAILED DESCRIPTION

[0017] The following will be combined with the drawings in the embodiments of the present application to clearly and completely describe the technical solutions in the embodiments of the present application. Obviously, the described embodiments are part of the embodiments of the present application, not all of the embodiments. Based on the embodiments in the present application, all other embodiments obtained by ordinary technicians in this field without creative work are within the scope of protection of this application.

[0018] In the case of private deployment of cloud products, the document management problems faced by multi-product and multi-version products are more significant. When users seek help and guidance, they expect the documents to fully match the product versions they use. How to ensure that the privately deployed products are consistent with the product documents? How to quickly and completely upgrade the corresponding product documents after the iteration of private products, and finally achieve the consistency of the multi-version documents of cloud SaaS products with the multi-version documents of local privately deployed products? The embodiment of this application is committed to solving the solution of document unification of multiple products and multiple product versions after the private deployment of cloud SaaS products on the customer's local site, as well as the solution of quickly upgrading and updating product version documents.

[0019] Specifically, local privatization deployment not only ensures the security of enterprise data, but also provides the greatest help and empowerment for enterprise development. Therefore, more and more SaaS platforms need to privatize and deploy cloud SaaS products to customers locally due to business growth and other reasons. When SaaS platform companies privatize and deploy products to customers, the deployed products should ensure consistency in the corresponding product documents, otherwise it will cause great trouble to customers to connect to privatized products, and it will also seriously affect the corporate image. The embodiment of this application takes solving the problem of consistency correspondence between multi-version products and documents and the actual local network environment of customers as the starting point, and proposes two solutions. Among them, Path 1 is that the program autonomously loads product documents consistent with the deployed product version, and no human participation is required during the period. If the customer cannot access the external network for some reason or the network access is slow when deploying the service, resulting in the failure of online initialization of the product document, at some point later, when the network conditions are restored, the corresponding product document can still be loaded by manually clicking the refresh button. Path 2 satisfies the customer's offline initialization by importing the product document database script that matches the customer when the external network cannot be accessed.

[0020] The core participants of the embodiment of the present application mainly include: cloud-based product service maintenance platform, customer product version management system, and private deployment of product services.

[0021] Accordingly, the technical solution of the embodiment of the present application mainly includes the following steps:

[0022] 1. Cloud product service maintenance platform: In the daily iteration process, the correspondence between product documents and versions should be maintained. At the same time, it should have the SQL capability to generate document data to support offline deployment. At the same time, it should have open-api to support online initialization of customer document content that can be initialized online.

[0023] 2. Customer product version management system: The deployment relationship metadata between specific customers and product versions should be maintained online, and an open-API for querying the deployed product version metadata based on the customer's unique ID should be provided.

[0024] 3. Privately deployed product services: After privately deployed product services, the product services should automatically trigger the process of pulling the corresponding deployed product version document metadata information from the cloud product service maintenance platform. This is used to implement online initialization of document metadata. The cloud product service maintenance platform can obtain the corresponding product metadata information from the customer product version management system based on the customer's unique identifier. After obtaining the corresponding product metadata, the privately deployed product service will parse and initialize it in the private environment, completing the online initialization action of the entire process.

[0025] The embodiment of the present application provides two initialization methods, online and offline. The online initialization method fully automates the entire process while solving the problem of consistency between product documents and versions. The initialization action of the document content can be completed without human participation during the private deployment process; the offline initialization method only requires manual import of SQL scripts to implement the initialization action of the document content. The embodiment of the present application is based on data model drive to maintain product versions and document versions, and provides open-api to support customers with external network access rights, and ultimately realizes the ability to automatically initialize document content online. The embodiment of the present application is based on the mapping relationship maintenance between data models and product versions, and realizes the ability to export product document content as SQL statements, and ultimately realizes the ability to initialize document data offline.

[0026] The following is a detailed description of the product document upgrade method provided by the embodiment of the present application through specific embodiments and their application scenarios in conjunction with the accompanying drawings.

[0027] like Figure 1 As shown, it is a flow chart of a method for upgrading a product document provided in an embodiment of the present application, and the method comprises the following steps:

[0028] Step 101, after the product service is privately deployed locally to the customer, product document metadata corresponding to the customer identity information is pulled through the product service according to the customer identity unique identifier.

[0029] In this embodiment, before pulling the product version metadata corresponding to the customer identity information through the product service based on the customer identity unique identifier, it also includes: maintaining the metadata of each product version privately deployed by each customer in the customer product version management system, and the customer product version management system provides an open application programming interface Open API for querying the product version metadata deployed by the customer based on the customer identity unique identifier, which is used by the cloud-based product service maintenance platform to obtain the corresponding product version metadata information based on the customer identity unique identifier.

[0030] In this embodiment, before extracting the product document metadata corresponding to the customer identity information through the product service according to the customer identity unique identifier, it also includes:

[0031] During the daily iteration of the product service, the correspondence between product documents and product versions is maintained through a cloud-based product service maintenance platform. The cloud-based product service maintenance platform has the structured query language SQL capability to generate document data based on the customer's unique identity identifier and provides an OpenAPI for obtaining product document metadata based on the customer's unique identity identifier.

[0032] Accordingly, the Open API of the cloud product service maintenance platform can be called through the product service according to the unique customer identity identifier to obtain the metadata resource package of the corresponding product document, wherein the resource package includes the product document metadata corresponding to the product version.

[0033] Furthermore, the cloud-based product service maintenance platform obtains the metadata of the corresponding product version through the Open API of the customer product version management system based on the customer unique identity identifier; the cloud-based product service maintenance platform generates the corresponding product document metadata based on the obtained product version metadata information.

[0034] Step 102: parse the product document metadata through the product service, initialize data in the private deployment environment according to the parsing result, and dynamically render the document site page according to the initialization data.

[0035] In this embodiment, in the daily version iteration of product services, the mapping relationship between products and product versions can also be maintained through the cloud-based product service maintenance platform, and an SQL statement for exporting product document metadata based on the customer's unique identity identifier can be provided as a data source for offline initialization of product document metadata; the cloud-based product service maintenance platform's ability to export matching product document SQL statements based on the customer's unique identity identifier is used to support the data source for offline initialization of product document metadata.

[0036] In addition, after pulling the product document metadata corresponding to the customer identity information through the product service according to the customer identity unique identifier, it also includes: in the case of failure to pull the product version metadata, offline initialization of the product document metadata according to SQL data.

[0037] like Figure 2 As shown, before the product document metadata corresponding to the customer identity information is pulled through the product service based on the customer identity unique identifier, it also includes: judging whether the customer has the conditions for external network access locally; the product document metadata corresponding to the customer identity information is pulled through the product service based on the customer identity unique identifier, specifically including: when the customer has the conditions for external network access locally, pulling the product document metadata corresponding to the customer identity information through the product service based on the customer identity unique identifier; after judging whether the customer has the conditions for external network access locally, it also includes: when the customer does not have the conditions for external network access locally, manually importing a product document database script matching the customer, initializing the product document metadata offline, and dynamically rendering the document site page based on the initialization data.

[0038] The embodiment of the present application realizes online automatic initialization of document content based on the mapping relationship between product version metadata and product document metadata, so that the version of the product and the document match consistency, and no additional version control tools are required, making the private deployment process more lightweight. When the customer does not have the conditions for external network access locally, the ability to initialize product document metadata offline can be realized by importing database scripts.

[0039] In the embodiment of the present application, the upgrade method of the above product document is described by taking the API document and product version of the product as an example, including the following steps:

[0040] 2.1. In the customer product version management system, it is necessary to maintain the metadata of each product version number of each customer's private deployment.

[0041] 2.2. In the daily version iteration of business products, when the product version changes, the product API documentation will usually change as well. The mapping relationship between the API documentation and each product version is maintained in the cloud product service maintenance platform. This process can be maintained repeatedly, and the system will use the last change record as the final version of this business version.

[0042] 2.3. The cloud-based product service maintenance platform can export the document sql file generated based on the customer's unique identity identifier as the data source for offline deployment (the cloud-based product service maintenance platform needs to provide sql export capabilities).

[0043] 2.4. During the deployment process, the private deployment platform will pull the deployment product version document metadata resource package corresponding to the customer from the "Cloud Product Service Maintenance Platform" based on the current customer's unique identity information.

[0044] 2.5. After pulling the document metadata, perform data initialization in the private deployment environment.

[0045] 2.6. If the pull in step 2.4 fails, the pull will be tried again until it succeeds or fails.

[0046] 2.7. If step 2.6 eventually fails, initialize the document metadata offline according to the SQL file in step 2.3.

[0047] 2.8. Online and offline initialization methods are used to ensure the consistency between the private deployment product version and the document version.

[0048] The embodiment of the present application provides two initialization methods, online and offline. The online initialization method fully automates the entire process while solving the problem of consistency between product documents and versions. The initialization action of the document content can be completed without human participation during the private deployment process; the offline initialization method only requires manual import of the SQL script to implement the initialization action of the document content. The embodiment of the present application manages the maintenance of document versions and version numbers based on data model drive, provides OpenApi to support customers with external network access rights, and ultimately realizes the ability to automatically initialize document content online. The embodiment of the present application is based on the mapping relationship maintenance between the data model and the product version, realizes the ability to export product document content as SQL statements, and ultimately realizes the ability to initialize document data offline. The embodiment of the present application does not require additional version control tools, and the entire deployment process is more lightweight.

[0049] The embodiment of the present application makes full use of the client's network conditions and the capabilities of openapi to reduce the human involvement of the entire upgrade process as much as possible, and achieves full automation. Under the condition that the client cannot access the external network, the document content can still be initialized based on SQL statements, and the document resources can be updated eventually.

[0050] like Figure 3 As shown, it is a structural schematic diagram of a product document upgrade device provided in an embodiment of the present application, including:

[0051] The pulling module 310 is used to pull the product document metadata corresponding to the customer identity information through the product service according to the customer identity unique identifier after the product service is privately deployed to the customer's local area.

[0052] The parsing module 320 is used to parse the product document metadata through the product service, and initialize data in the private deployment environment according to the parsing result, and dynamically render the document site page according to the initialization data.

[0053] In this embodiment, the above device further includes:

[0054] The first maintenance module is used to maintain the metadata of each product version privately deployed by each customer in the customer product version management system. The customer product version management system provides an open application programming interface Open API for querying the product version metadata deployed by the customer based on the customer's unique identity identifier, which is used for the cloud-based product service maintenance platform to obtain the corresponding product version metadata information based on the customer's unique identity identifier.

[0055] The second maintenance module is used to maintain the correspondence between product documents and product versions through a cloud-based product service maintenance platform during the daily iteration of the product service. The cloud-based product service maintenance platform has the structured query language SQL capability to generate document data based on the customer's unique identity identifier and provides an Open API for obtaining product document metadata based on the customer's unique identity identifier.

[0056] Correspondingly, the pulling module 310 is specifically used to call the Open API of the cloud-based product service maintenance platform through the product service according to the unique customer identity identifier, to obtain the metadata resource package of the corresponding product document, wherein the resource package includes the product document metadata corresponding to the product version; the cloud-based product service maintenance platform is used to obtain the metadata of the corresponding product version through the Open API of the customer product version management system according to the unique customer identity identifier; and generate the corresponding product document metadata based on the obtained product version metadata information.

[0057] Furthermore, the above device further comprises:

[0058] The third maintenance module is used to maintain the mapping relationship between products and product versions through the cloud product service maintenance platform during daily version iterations of product services. The cloud product service maintenance platform provides SQL export capabilities as a data source for offline initialization of product document metadata.

[0059] The initialization module is used to initialize the product document metadata offline according to SQL data when the product document metadata fails to be pulled.

[0060] The judgment module is used to judge whether the local client has the conditions for external network access.

[0061] The import module is used to initialize the product document metadata offline by manually importing the product document database script that matches the customer when the customer does not have local external network access conditions, and dynamically render the document site page based on the initialization data.

[0062] Correspondingly, the pulling module 310 is specifically used to pull the product document metadata corresponding to the customer identity information through the product service according to the customer identity unique identifier when the customer has the external network access condition locally.

[0063] The embodiment of the present application realizes online automatic initialization of document content based on the mapping relationship between product version metadata and product document metadata, so that the version of the product and the document match consistency, and no additional version control tools are required, making the private deployment process more lightweight. When the customer does not have the conditions for external network access locally, the ability to initialize product document metadata offline can be realized by importing database scripts.

[0064] The embodiment of the present application also provides a computer-readable storage medium, on which a computer program is stored, and when the computer program is executed by a processor, each process of the above-mentioned product document upgrade method embodiment is implemented, and the same technical effect can be achieved. To avoid repetition, it is not repeated here. The computer-readable storage medium is, for example, a read-only memory (ROM), a random access memory (RAM), a magnetic disk or an optical disk.

[0065] It should be noted that, in this article, the terms "include", "comprises" or any other variations thereof are intended to cover non-exclusive inclusion, so that a process, method, article or device including a series of elements includes not only those elements, but also other elements not explicitly listed, or also includes elements inherent to such process, method, article or device. In the absence of further restrictions, an element defined by the sentence "comprises a ..." does not exclude the existence of other identical elements in the process, method, article or device including the element.

[0066] Through the description of the above implementation methods, those skilled in the art can clearly understand that the above-mentioned embodiment methods can be implemented by means of software plus a necessary general hardware platform, and of course by hardware, but in many cases the former is a better implementation method. Based on such an understanding, the technical solution of the present application, or the part that contributes to the prior art, can be embodied in the form of a software product, which is stored in a storage medium (such as ROM / RAM, a magnetic disk, or an optical disk), and includes a number of instructions for a terminal (which can be a mobile phone, a computer, a server, an air conditioner, or a network device, etc.) to execute the methods described in each embodiment of the present application.

[0067] The embodiments of the present application are described above in conjunction with the accompanying drawings, but the present application is not limited to the above-mentioned specific implementation methods. The above-mentioned specific implementation methods are merely illustrative and not restrictive. Under the guidance of the present application, ordinary technicians in this field can also make many forms without departing from the purpose of the present application and the scope of protection of the claims, all of which are within the protection of the present application.

Claims

1. A method for upgrading product documentation, characterized in that: The following steps are involved: After the product service is privately deployed locally on the customer, the product document metadata corresponding to the customer identity information is pulled through the product service according to the customer's unique identity identifier; The product document metadata is parsed through the product service, and data is initialized in a private deployment environment according to the parsing result, and the document site page is dynamically rendered according to the initialization data.

2. The method according to claim 1, characterized in that Before extracting the product version metadata corresponding to the customer identity information through the product service according to the customer identity unique identifier, the method further includes: The metadata of each product version privately deployed by each customer is maintained in the customer product version management system. The customer product version management system provides an open application programming interface Open API for querying the product version metadata deployed by the customer based on the customer's unique identity identifier, which is used by the cloud-based product service maintenance platform to obtain the corresponding product version metadata information based on the customer's unique identity identifier.

3. The method according to claim 1, characterized in that Before extracting product document metadata corresponding to the customer identity information through the product service according to the customer identity unique identifier, the method further includes: In the daily iteration process of the product service, the correspondence between product documents and product versions is maintained through a cloud-based product service maintenance platform, which has the structured query language SQL capability to generate document data based on the customer identity unique identifier and provides an Open API for obtaining product document metadata based on the customer identity unique identifier; The extracting, through the product service, product document metadata corresponding to the customer identity information according to the customer identity unique identifier specifically includes: According to the unique customer identity identifier, the Open API of the cloud product service maintenance platform is called through the product service to obtain a metadata resource package of the corresponding product document, wherein the resource package includes product document metadata corresponding to the product version; The method further comprises: The cloud product service maintenance platform obtains the metadata of the corresponding product version through the Open API of the customer product version management system according to the customer unique identity identifier; The cloud-based product service maintenance platform generates corresponding product document metadata based on the acquired product version metadata information.

4. The method according to claim 3, characterized in that Also includes: In the daily version iteration of product services, the mapping relationship between products and product versions is maintained through the cloud product service maintenance platform. The cloud product service maintenance platform provides SQL export capabilities as a data source for offline initialization of product document metadata; After extracting the product document metadata corresponding to the customer identity information through the product service according to the customer identity unique identifier, the method further includes: In the event that pulling product document metadata fails, the product document metadata is initialized offline based on SQL data.

5. The method according to claim 1, characterized in that Before extracting product document metadata corresponding to the customer identity information through the product service according to the customer identity unique identifier, the method further includes: Determine whether the client has the conditions to access the external network locally; The extracting of product document metadata corresponding to the customer identity information through the product service according to the customer identity unique identifier specifically includes: When the customer has the conditions for external network access locally, the product document metadata corresponding to the customer identity information is pulled through the product service according to the customer's unique identity identifier; After determining whether the client has the conditions for external network access locally, the method further includes: When the customer does not have local access to the Internet, the product document database script that matches the customer is manually imported to initialize the product document metadata offline, and the document site page is dynamically rendered based on the initialization data.

6. A device for upgrading product documents, characterized in that: include: A pulling module is used to pull product document metadata corresponding to the customer identity information through the product service according to the customer identity unique identifier after the product service is privately deployed to the customer's local area; The parsing module is used to parse the product document metadata through the product service, and initialize data in the private deployment environment according to the parsing result, and dynamically render the document site page according to the initialization data.

7. The device according to claim 6, characterized in that Also includes: The first maintenance module is used to maintain the metadata of each product version privately deployed by each customer in the customer product version management system. The customer product version management system provides an open application programming interface Open API for querying the product version metadata deployed by the customer based on the customer's unique identity identifier, which is used for the cloud-based product service maintenance platform to obtain the corresponding product version metadata information based on the customer's unique identity identifier.

8. The device according to claim 6, characterized in that Also includes: A second maintenance module is used to maintain the correspondence between product documents and product versions through a cloud-based product service maintenance platform during the daily iteration of the product service. The cloud-based product service maintenance platform has a structured query language SQL capability to generate document data based on a customer identity unique identifier and provides an Open API for obtaining product document metadata based on a customer identity unique identifier; The pulling module is specifically used to call the Open API of the cloud-based product service maintenance platform through the product service according to the unique customer identity identifier to obtain the metadata resource package of the corresponding product document, wherein the resource package includes the product document metadata corresponding to the product version; the cloud-based product service maintenance platform is used to obtain the metadata of the corresponding product version through the Open API of the customer product version management system according to the unique customer identity identifier; and generate the corresponding product document metadata according to the obtained product version metadata information.

9. The device according to claim 8, characterized in that Also includes: The third maintenance module is used to maintain the mapping relationship between products and product versions through the cloud product service maintenance platform in the daily version iteration of the product service. The cloud product service maintenance platform provides SQL export capability as a data source for offline initialization of product document metadata; The initialization module is used to initialize the product document metadata offline according to SQL data when the product document metadata fails to be pulled.

10. The device according to claim 6, characterized in that Also includes: A judgment module is used to judge whether the client has the conditions for external network access locally; The import module is used to manually import the product document database script that matches the customer when the customer does not have the conditions for external network access locally, initialize the product document metadata offline, and dynamically render the document site page according to the initialization data; The pulling module is specifically used to pull the product document metadata corresponding to the customer identity information through the product service according to the customer identity unique identifier when the customer has the external network access condition locally.

Images