-
Notifications
You must be signed in to change notification settings - Fork 86
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
Deprecate datasources and promote the flux_bootstrap_git
docs
#444
Conversation
f2502bc
to
df8f051
Compare
I think we should also rename the guides: github.md, gitlab.md and customise.md should contain the updated docs, otherwise Google will point people to old docs. |
Signed-off-by: Philip Laine <[email protected]>
Signed-off-by: Stefan Prodan <[email protected]>
- Rename and update the files in the template directory as per the updates to the guide docs in the previous commit. - Fix the strange file name for new github guide in the registry navigation panel by fixing the frontmatter yaml. Because of invalid yaml, the renderer was using the file name as the page name in the navigation panel. This issue was also being highlighted in the github markdown render as: ``` Error in user YAML: (<unknown>): found a tab character where an intendation space is expected while scanning a block scalar at line 3 column 14 ``` Signed-off-by: Sunny <[email protected]>
3e9b995
to
a8b9fd6
Compare
Since it's a prerelease, update the examples and docs to explicitly use the RC version. Signed-off-by: Sunny <[email protected]>
flux_bootstrap_git
docs
The reason the tests are not passing is because provider dev overrides does not apply to init. Meaning it will annoyingly try to resolve the version of the Flux provider which does not exist. |
Is there a fix or should we merge it like this? |
158fb83
to
6f8cb29
Compare
Using the version of the provider that's not published from the example configuration in e2e test fails because `terraform init` queries the upstream terraform registry for the same version and fails when the upstream returns an error, as it's unpublished. Remove the version field from the example configuration to avoid this failure. The `dev_overrides` in .terraformrc will make sure that the e2e test uses the local provider instead of the downloaded old provider. Signed-off-by: Sunny <[email protected]>
6f8cb29
to
92a95ba
Compare
Discussed with @phillebaba about it and decided to remove the version field from the example that's used in the e2e test. All the other examples continue to have the version. |
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.
LGTM
Thanks @phillebaba and @darkowlzz
This change deprecates the flux_install and flux_sync datasource. It adds a deprecation notice to the datasources and moves the guides to a deprecated sub category.
Also:
navigation panel by fixing the frontmatter yaml. Because of invalid
yaml, the renderer was using the file name as the page name in the
navigation panel. This issue was also being highlighted in the github
markdown render as:
Based on the docs
Part of: #426