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

Branding and copy editing changes to the Apicurio Studio docs #63

Merged
merged 1 commit into from
Apr 9, 2024

Conversation

EricWittmann
Copy link
Contributor

Mostly this is branding of Apicurio vs. APICurio. And also making sure that Apicurio Studio is used throughout, to disambiguate it from other Apicurio projects (e.g. Registry). Also maybe one or two typo fixes.

That said, the documentation doesn't mention that you can add the x-kuadrant extension without switching to the full Source tab. The implication I think is that editing the Source directly is required. But users can use the Add Extension dialog instead, which I would argue is a little easier. However, that dialog does require JSON instead of YAML:

image

I'd be happy to contribute relevant changes if desired. I wasn't sure if the documentation was written this way because it was the preferred way to make the change, or if the Add Extension dialog wasn't discovered by the author. :)

@david-martin
Copy link
Contributor

I'd be happy to contribute relevant changes if desired

That would be awesome @EricWittmann Thanks.
I didn't add it as I wasn't aware it could be done that way.
That's a nice handy shortcut

@EricWittmann
Copy link
Contributor Author

OK great. Do you want to merge this first or shall I just update this PR with the proposed change?

@david-martin
Copy link
Contributor

We can hold this pr while you make the updates here

@jasonmadigan
Copy link
Member

@EricWittmann thanks a lot! I'd be happy to merge these edits right away. Feel free to send along another PR when you get some time for more improvements!

@jasonmadigan
Copy link
Member

Will trigger a docs rebuild afterwards.

@EricWittmann
Copy link
Contributor Author

Yep! This is still on my to-do list. 😀

@jasonmadigan jasonmadigan merged commit 102017b into Kuadrant:main Apr 9, 2024
5 checks passed
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.

3 participants