Asciidoctor :: Discussion - Re: How to show changes between two docs in the new version

Re: How to show changes between two docs in the new version

Posted by mojavelinux on May 15, 2019; 6:22am
URL: https://discuss.asciidoctor.org/How-to-show-changes-between-two-docs-in-the-new-version-tp6915p6917.html

To build on what Abel suggested, code management tools like GitHub offer numerous views for comparing changes. On GitHub, append /compare to any repository URL to bring up the interface. The following article explains how to use it: https://help.github.com/en/articles/comparing-commits-across-time

Here's an example of comparing content changes across versions in the Couchbase Java SDK docs.

https://github.com/couchbase/docs-sdk-java/compare/release/2.7...release/2.6#diff-188b5ba2ab6d96103d2f83337130f7c1

(click on "Files Changed" to see the actual file changes)

Using buttons in the upper right corner of any file entry, you can view both the source and prose (rendered) differences for that file. Here's an example of how the prose diff looks.

Similar views are available when submitting a pull request (aka merge request).

This the main tool we recommend for conducting this sort of analysis.

Cheers,

-Dan

On Tue, May 14, 2019 at 11:44 PM abelsromero [via Asciidoctor :: Discussion] <[hidden email]> wrote:

Welcome to the forum :)

For those features the recommendation is to store the source documents in a version control system like git (https://git-scm.com/). Git provides these features and you can use services like GitHub or GitLab for collaborative workflows and review the changes on a nice website.
I personally prefer GitLab, it even includes an online editor.

If you are not familiar with such tools just google for some quickstarts and definitely give them a try.

If you reply to this email, your message will be added to the discussion below:
http://discuss.asciidoctor.org/How-to-show-changes-between-two-docs-in-the-new-version-tp6915p6916.html

To start a new topic under Asciidoctor :: Discussion, email [hidden email]
To unsubscribe from Asciidoctor :: Discussion, click here.
NAML

Dan Allen | @mojavelinux | https://twitter.com/mojavelinux