Skip to content

Conversation

@nmelehan
Copy link
Contributor

@nmelehan nmelehan commented Jan 17, 2019

This PR is a followup to #2040:

In that previous PR, a number of shortguides were created to embed instructions in the new Download Files from your Linode guide. This proved hard to copy edit, as changes in the shortguides made for unexpected changes in the flow of the embedding guide.

This PR removes most of the shortguides from that PR and updates the Download Files from your Linode guide so that it just links to the instructions.

To review this PR, open these guides and just read them to make sure they make sense:

docs/databases/mysql/use-mysqldump-to-back-up-mysql-or-mariadb
docs/platform/disk-images/copying-a-disk-image-over-ssh
docs/security/data-portability/download-files-from-your-linode

nmelehan and others added 3 commits January 17, 2019 11:37
When I originally created the Data Portability section, I created a
number of shortguides in order to embed relevant instructions into the
new data portability guides. For example:

1. I extracted the Download a Disk over SSH section of the Copying a
Disk over SSH guide and put it into a new copy-disk-over-ssh-short
shortguide
2. I then embedded this shortguide into the content's original Copying a
Disk over SSH guide, and I also embedded it into the new Download Files
from your Linode guide.

This was also done for other instructions: making a database dump with
mysql, and using filezilla to download files.

This proved to be harder to copy edit, as copy edit changes inside a
shortguide can result in unintended changes to the "flow" of the
embedding guide.

This commit is rolling back most of the shortguides in favor of just
linking to the content. To take the example of copying a disk over SSH,
I am:

1. Pasting the content of the copy-disk-over-ssh-short shortguide back
into the Copying a Disk over SSH guide, where it originally lived.
2. Linking to that guide from the Download Files from your Linode guide.
@cwlinode cwlinode merged commit af41ad1 into linode:develop Jan 18, 2019
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants