Migrate most of remaining docs from old-docs #383
Closed
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.
This does a basic move on the remaining stuff in old-docs, which (if I'm following the other issues properly) is the way @mrparkers is heading (towards hosting docs on the terraform provider page). This does not break mkdocs at all, so all documentation can continue to be hosted at the current gh-pages site (although any deep links to specific pages would now return a 404). The only thing I didn't update was the index - it seems like perhaps the TODO here is to decide if the new documentation index should have a subsection on how to install for "legacy" users (in quotes because it's not qutie legacy yet until the new provider version is release, as I understand it)
This also add a small but useful utility script,
check-docs.sh
. It's an unintelligent script that looks for possibly missing documentation files. In looking at solving my own issue #382 I noticed there is already ageneric_keycloak_identity_provider_mapper.go
with no docs page (not yet sure if it will solve my issue, but nice to know about), and I saw a few other issues where docs just needed some update. As I said, the script is basic, it spits out 10-15 possibilities and expects a human to scan them and weed out false positives. But..it took 5min to write ;-)Here's the initial output: