Skip to content

Improved markdown templates #252

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

Merged
merged 3 commits into from
Sep 23, 2020
Merged

Improved markdown templates #252

merged 3 commits into from
Sep 23, 2020

Conversation

kozl
Copy link

@kozl kozl commented Sep 16, 2020

  • Added parameter list for classes, defines, data types and resource types with links to detailed parameter description. Useful for classes that have lots of parameters
  • Fixed anchor links in markdown templates — original ones didn't work at Bitbucket

@binford2k
Copy link
Contributor

@kozl Thanks for the PR! 🥳

Could you break this into two separate commits? One to add the parameter lists and one to add the anchors. This makes it easier to revert either of those if we ever need to.

Can you take a look at the failing tests? It looks like the templates are not compiling properly.

@kozl
Copy link
Author

kozl commented Sep 17, 2020

Yeah, sure! I'll come back a little bit later with that

@kozl
Copy link
Author

kozl commented Sep 21, 2020

Forgot another thing: I've fixed how data types aliases are displayed. They get unreadable for large data types:
https://www.imageupload.net/image/4KjFb

Broke all changes in separete commits and fixed tests

@kozl
Copy link
Author

kozl commented Sep 22, 2020

Who is going to merge this? I don't have permissions

@binford2k
Copy link
Contributor

@kozl we do a biweekly Tuesday triage & review. Next one is a week from today.

@daianamezdrea
Copy link
Contributor

Hi @kozl, this looks good! Thank you for your contribution! Cheers!

@daianamezdrea daianamezdrea changed the title Improved makdown templates Improved markdown templates Sep 23, 2020
@daianamezdrea daianamezdrea merged commit 8b5731d into puppetlabs:main Sep 23, 2020
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants