Move content into content/docs #1128
Conversation
| <a href="{{< relref "/reference" >}}"><button class="button primary">LEARN</button></a> | ||
| <a href="{{< relref "/docs/quickstart/install.md" >}}"><button class="button primary">INSTALL</button></a> | ||
| <a href="{{< relref "/docs/quickstart" >}}"><button class="button primary">GET STARTED</button></a> | ||
| <a href="{{< relref "/docs/reference" >}}"><button class="button primary">LEARN</button></a> |
There was a problem hiding this comment.
This file (among many) isn't showing up as a move. Since the content changed too much, git thinks we deleted a file and added a new one. This is the downside of moving the files and updating their content in the same commit. In order to maintain history for a file, I had to move the files in one commit but not change their content (so git tracks it as a move), and then in a subsequent commit modify the content of the moved files to update links, etc.
There was a problem hiding this comment.
Oh, I see -- I'll try that.
There was a problem hiding this comment.
If you want to save yourself a bunch of hassle breaking this up into two commits, copy the whole /content/docs directory with these changes to a temporary directory somewhere on your machine for temporary safe keeping.
Then start fresh and move the /content into /content/docs, but don't modify any files. Commit.
Then delete everything in /content/docs and replace it with the directory you stashed away, which should have all the modifications. And commit those changes.
There was a problem hiding this comment.
Ok, I think this should be good now. Got through a full docs run and while I hit a few warnings, things seem to have completed successfully.
cnunciato
force-pushed
the
cnunciato/subdir
branch
from
a8f4117 to
6ad6be2
Compare
| @@ -304,38 +304,10 @@ deployments. | |||
| Use this data source to get the ID of a registered AMI for use in other | |||
| resources. | |||
|
|
|||
| ## Example Usage | |||
There was a problem hiding this comment.
It looks like examples are missing in all these re-generated docs. I'm guessing the tf2pulumi tool isn't found on your $PATH?
On my various machines, I've cloned https://github.com/pulumi/tf2pulumi in my go directory, and then I run make ensure and make build && make install.
justinvp
left a comment
justinvp
left a comment
There was a problem hiding this comment.
Other than examples missing from generated API docs, LGTM.
|
@justinvp Thanks much, that did it. All should be good now. I'll go ahead and merge. |
Signed-off-by: Christian Nunciato <c@nunciato.org>
cnunciato
force-pushed
the
cnunciato/subdir
branch
from
7f139b4 to
c2bdf39
Compare
This change shifts all docs content into a subdirectory (/docs) and adjusts navigation, TOCs and doc generation accordingly. It does not include any redirects or aliases yet -- just moves all content into a new directory, and makes everything navigable.