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

techdocs: Update example documentation #4983

Merged
merged 6 commits into from Mar 17, 2021

Conversation

adamdmharvey
Copy link
Member

@adamdmharvey adamdmharvey commented Mar 17, 2021

Signed-off-by: Adam Harvey adam.harvey@dxc.com

Fixes #4237

Hey, I just made a Pull Request!

Adds a few more examples to better showcase what TechDocs provides out of the box.

Fixes the code example and also adds Python:

image

Adds a showcase of more of the features, such as admonitions, PlantUML, and pymdown extensions:

image

image

image

Possible discovered TechDocs bugs?

Many images from these extensions look broken to me on my localhost. I see a CSS error in the React console relating to the mimetype, but I feel like that is separate. The admonition icons aren't showing up for me, neither are the check marks for the task list. However, the emojis look fine?

So I have a feeling my screen shots are accurate, but just might represent a separate bug that perhaps the plugin is not correctly rendering images from the Pymdown extensions?

I'd say also I expected the warning admonition to be a different color, so that may be a CSS trick we're missing there. From the source project it looks like:

image

But renders blue in TechDocs.

✔️ Checklist

  • A changeset describing the change and affected packages. (more info)
  • Added or updated documentation
  • Tests for new functionality and regression tests for bug fixes
  • Screenshots attached (for UI changes)
  • All your commits have a Signed-off-by line in the message. (more info)

Signed-off-by: Adam Harvey <adam.harvey@dxc.com>
Signed-off-by: Adam Harvey <adam.harvey@dxc.com>
Signed-off-by: Adam Harvey <adam.harvey@dxc.com>
@adamdmharvey adamdmharvey requested a review from a team as a code owner March 17, 2021 02:51
@changeset-bot
Copy link

changeset-bot bot commented Mar 17, 2021

⚠️ No Changeset found

Latest commit: 9b3a205

Merging this PR will not cause a version bump for any packages. If these changes should not result in a new version, you're good to go. If these changes should result in a version bump, you need to add a changeset.

This PR includes no changesets

When changesets are added to this PR, you'll see the packages that this PR includes changesets for and the associated semver types

Click here to learn what changesets are, and how to add one.

Click here if you're a maintainer who wants to add a changeset to this PR

@adamdmharvey adamdmharvey added the area:techdocs Related to the TechDocs Project Area label Mar 17, 2021
Signed-off-by: Adam Harvey <adam.harvey@dxc.com>
Signed-off-by: Adam Harvey <adam.harvey@dxc.com>
@adamdmharvey adamdmharvey requested a review from a team as a code owner March 17, 2021 02:58
@OrkoHunter OrkoHunter added this to Incoming in TechDocs project board via automation Mar 17, 2021
Copy link
Member

@OrkoHunter OrkoHunter left a comment

Choose a reason for hiding this comment

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

Possible discovered TechDocs bugs?

That's why we need such a rich page examples with all MkDocs extensions being rendered properly (or not)! Thanks 😁

Comment on lines 27 to 30
def getUsersInGroup( targetGroup, secure = False ):

if __debug__:
print ('targetGroup=[' + targetGroup + ']')
Copy link
Member

Choose a reason for hiding this comment

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

Suggested change
def getUsersInGroup( targetGroup, secure = False ):
if __debug__:
print ('targetGroup=[' + targetGroup + ']')
def getUsersInGroup(targetGroup, secure=False):
if __debug__:
print('targetGroup=[' + targetGroup + ']')

PEP8 speaks in my head :D

Copy link
Member Author

Choose a reason for hiding this comment

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

I'm still old school two spaces after a period kinda guy, it's so hard not to hit the spacebar ha ha

Signed-off-by: Adam Harvey <adam.harvey@dxc.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
area:techdocs Related to the TechDocs Project Area
Projects
No open projects
Development

Successfully merging this pull request may close these issues.

Docs: Improve TechDocs example documentation component
3 participants