Skip to content
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

Update MR Section #457

Merged
merged 18 commits into from
Jun 29, 2023
Merged

Update MR Section #457

merged 18 commits into from
Jun 29, 2023

Conversation

plumbis
Copy link
Collaborator

@plumbis plumbis commented May 31, 2023

This rewrites the concepts/managed resources providing more details and structure and passing Vale checks.

The original content providing examples on importing existing resources with ObserveOnly has been moved out into a stand-alone KB.

Resolves #453, #272.

Signed-off-by: Pete Lumbis [email protected]

plumbis added 10 commits May 24, 2023 13:08
Signed-off-by: Pete Lumbis <[email protected]>
Signed-off-by: Pete Lumbis <[email protected]>
Signed-off-by: Pete Lumbis <[email protected]>
Signed-off-by: Pete Lumbis <[email protected]>
Signed-off-by: Pete Lumbis <[email protected]>
Signed-off-by: Pete Lumbis <[email protected]>
Signed-off-by: Pete Lumbis <[email protected]>
Signed-off-by: Pete Lumbis <[email protected]>
@netlify
Copy link

netlify bot commented May 31, 2023

Deploy Preview for crossplane ready!

Name Link
🔨 Latest commit abd1250
🔍 Latest deploy log https://app.netlify.com/sites/crossplane/deploys/649b18737fbb770008144543
😎 Deploy Preview https://deploy-preview-457--crossplane.netlify.app
📱 Preview on mobile
Toggle QR Code...

QR Code

Use your smartphone camera to open QR code link.

To edit notification comments on pull requests, go to your Netlify site configuration.

Copy link
Member

@jbw976 jbw976 left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

deployment preview question: navigating using the left hand nav pane doesn't seem to work to jump between the different high level sections of the docs (e.g. user docs, knowledge base, contrib guide).

e.g. from https://64778c8b7c25e60008bdd3ac--crossplane.netlify.app/v1.12/concepts/providers/, the left hand nav pane has links to this for "Knowledge Base", which is broken. Looks like knowledge-base is being included in the domain of the URL:

https://64778c8b7c25e60008bdd3ac--crossplane.netlify.appknowledge-base/

utils/vale/styles/Crossplane/spelling-exceptions.txt Outdated Show resolved Hide resolved
Copy link
Member

@jbw976 jbw976 left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This is pretty great @plumbis, good job dude!! 💪 🙇‍♂️

I have a few questions and feedback, but nothing major here - I also reviewed thoroughly the 1.12 content (and import content) and assumed that the v1.11 and master branches content were essentially the same.

content/knowledge-base/guides/import-existing-resources.md Outdated Show resolved Hide resolved
content/v1.12/concepts/managed-resources.md Outdated Show resolved Hide resolved
content/v1.12/concepts/managed-resources.md Outdated Show resolved Hide resolved
content/v1.12/concepts/managed-resources.md Show resolved Hide resolved
content/v1.12/concepts/managed-resources.md Show resolved Hide resolved
@@ -3,630 +3,745 @@ title: Managed Resources
weight: 102
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

meta: the right hand "on this page" TOC is long enough to scroll by default, but there's no obvious visual indication that it can be scrolled. any improvements you've already been thinking about making there?

Copy link
Collaborator Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

🤔 what browser? There should be a scrollbar
Screenshot 2023-06-27 at 12 53 33 PM

@plumbis
Copy link
Collaborator Author

plumbis commented Jun 27, 2023

using the left hand nav pane doesn't seem to work to jump between the different high level sections of the docs

Great catch @jbw976 . This was an error in the variable used to build the docs in a "preview" context. I pushed a fix.

@plumbis plumbis requested a review from jbw976 June 27, 2023 17:15
@plumbis plumbis merged commit d05ad1a into crossplane:master Jun 29, 2023
@plumbis plumbis deleted the mrs branch June 29, 2023 16:02
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.

Update concepts/managed-resources
3 participants