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

[MNGSITE-349] Add instructions for small documentation changes #687

Merged
merged 3 commits into from
Feb 16, 2025

Conversation

Bukama
Copy link
Contributor

@Bukama Bukama commented Feb 15, 2025

No description provided.

@Bukama
Copy link
Contributor Author

Bukama commented Feb 15, 2025

@slawekjaranowski Your bsky post motivated me to no longer postpone it :D

** Small amendments of the documentation

If you want to submit small site amendments, for example correct a spelling mistake, you don't have to do the full setup described before.
You can simply hit the "Edit" button after the page's title the breadcrumb section on the top of the page.
Copy link
Member

Choose a reason for hiding this comment

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

After "Edit" I would like to add an edit icon as image.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

While it was easy in the markdown file, I spent an hour trying to get in done in the apt file without getting it done. It looks like apt only supports stand alone images but not inline in text.

    You can simply hit the "Edit" [/images/accessories-text-editor.png] Edit button after the page's title in the breadcrumb section on the top of the page.

[/images/accessories-text-editor.png] Edit

The second gets correctly displayed as an image, the first is just text. I also tried to link to the image, but that's results (as expected) in a link. In whole site repository we also don't have any apt file with inline image (we had xdoc but no apt).

So I decided to leave out the icon for the moment to keep the text change isolated, but will add it, when I convert the page to markdown in a separate PR.

(However I fixed the subsection heading of the apt file)

@Bukama Bukama merged commit c8e3d79 into apache:master Feb 16, 2025
1 check passed
@Bukama Bukama deleted the mngsite349_editsitedoc branch February 16, 2025 16:46
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