-
-
Notifications
You must be signed in to change notification settings - Fork 261
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Create a guide for migration of docs #544
Open
JeremiahSecrist
wants to merge
7
commits into
NixOS:master
Choose a base branch
from
JeremiahSecrist:master
base: master
Could not load branches
Branch not found: {{ refName }}
Loading
Could not load tags
Nothing to show
Loading
Are you sure you want to change the base?
Some commits from the old base branch may be removed from the timeline,
and old review comments may become outdated.
Open
Changes from 4 commits
Commits
Show all changes
7 commits
Select commit
Hold shift + click to select a range
844e6c0
Create a guide for migration of docs.
JeremiahSecrist 22a6038
Added document to toctree
JeremiahSecrist 22ea38a
Merge branch 'NixOS:master' into master
JeremiahSecrist 25be999
Created adjustments for @zmitchell review
JeremiahSecrist 4d72d09
Fixed spelling and comprehension issues, refactored docs assesment.
JeremiahSecrist 13e1a6d
language issues on line 35
JeremiahSecrist 1d80c13
Fixed accidental removal of heading
JeremiahSecrist File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,45 @@ | ||
# Migrating Documentation | ||
|
||
Migrating documentation is often crucial when reorganizing any project. As such, below is a list of instructions and guidelines to aid you when embarking on the migration journey. | ||
|
||
## Licensing | ||
1. Familiarize yourself with the licenses governing the documentation you intend to migrate. | ||
2. Verify that the license of the documentation is compatible with this project's current license. | ||
3. If the licenses align, proceed with the migration. Otherwise, follow the steps 4 thourgh 7. | ||
4. Identify the file and determine all contributors to the documentation (typically using blame or a co-owners document). | ||
5. Contact all contributors, requesting permission to migrate the document to the new license. | ||
6. Await responses from all recipients and obtain explicit approval from each contributor before proceeding. | ||
7. If agreement from all contributors cannot be obtained, consider alternative solutions to avoid licensing conflicts, such as: | ||
- A full rewrite of the document. | ||
- Rewriting the areas of specific contributors who did not reply or approve. | ||
|
||
## Documentation Assessment | ||
1. Perform a thorough review of the existing documentation. | ||
2. Assess the scope, relevance, and quality of the documentation in relation to the migration location. | ||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. It's not clear to me what "quality of the documentation in relation to the migration location" means. There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. This still needs to be addressed |
||
3. Consider factors such as: | ||
- Completeness | ||
- Accuracy | ||
- Organization | ||
- Readability | ||
4. Be sure to identify the type of document that it is easily classifiable as one of the following: | ||
- Reference | ||
- Concept | ||
- Tutorial | ||
- Recipe | ||
5. If it does not properly classify under step 4 then one will need to consider the following options: | ||
- Rewrite the document to conform | ||
- Split it up into multiple documents | ||
- Abondoning the work entirely if it's not feasible | ||
|
||
## Version Control and Branching Strategy | ||
Determine the appropriate branch in the repository that contains the most up-to-date or relevant information about the project. In some situations, one often assumes the latest branch is often main or master. Yet in contrast, it can be located in other branches such as beta, next, etc. | ||
|
||
## Visual Quality Assurance | ||
1. Please make sure the table of contents is structured correctly on the actual site and navigate as expected. | ||
2. Check the following aspects to function or render as intended: | ||
- Headings | ||
- Sections | ||
- Code Formatting | ||
- Tables | ||
- links | ||
- Images and Diagrams |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I think this needs a bit of motivation. Something like that there is a lot of good stuff out there. You may find a piece of writing that covers a topic you want documented very nicely. But different projects, repositories, groups of people - for various reasons - put their work under free but different and possibly incompatible licenses, which may preclude using it for our purposes straight away. (Please don't take this verbatim...)