-
Notifications
You must be signed in to change notification settings - Fork 12
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
Tutorial #12
base: feature/with-full-readme
Are you sure you want to change the base?
Tutorial #12
Conversation
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I have no jurisdiction outside of being our company's documentation girl, but as far as my approval goes; it looks good!
@Denperidge how does this work on the semantic.works site? do you know? |
@nvdk The semantic.works rework should be easily adaptable to a new structure! Tutorials is currently rendered IN IT by grabbing the mu-project repo object, getting its newest revision, and then loading the markdown string from repo-revision.tutorials. It should still load, and perhaps we could stringify a json dictionary of TUTORIAL_NAME: MARKDOWN_STRING |
If you're reading this trying to figure out why this link doesn't work, maybe the [pull request](mu-semtech/project#5) hasn't been merged yet. In which case, you want to look here: https://github.com/Denperidge-Redpencil/docs-update-project/blob/master/docs/how-tos/troubleshooting---slow-starting-containers.md
If the why-semantic-tech link does not work, please see https://github.com/Denperidge-Redpencil/du-project/blob/master/docs/discussions/why-semantic-tech.md
I've split the tutorials out to their own file as the README.md seems very unwieldy. The resulting TUTORIALS.md is still unwieldy but this way allows for other content to be added to the readme without it being lost under tutorials.
If we want to keep everything in one large file, we can either trivially re-work the commits or just pull the separate file back into the readme.
This now includes the https://mu.semte.ch/getting-started/ tutorial in the tutorials here, so there's no longer a jump to having an ember UI with no explanation, as well as many small tweaks and a troubleshooting section for the file-limits problem.