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

Improve scaffolder docs #1444

Merged
merged 5 commits into from
Dec 4, 2024
Merged

Improve scaffolder docs #1444

merged 5 commits into from
Dec 4, 2024

Conversation

sblausten
Copy link
Contributor

@sblausten sblausten commented Dec 3, 2024

https://app.shortcut.com/larder/story/23952/uplight-extending-existing-templates

https://deploy-preview-1444--roadie.netlify.app/docs/scaffolder/writing-templates/

  • Some folder changes to make navigating our code easier
  • Fix a few things and improve page on grouping and certified templates which was orphaned from nav
  • Add examples on placeholder usage with external files
  • Add example of placeholder usage for steps

@@ -67,6 +67,7 @@
"react-tabs": "^4.2.1",
"react-use": "^17.2.4",
"remark-html": "^13.0.2",
"sharp": "^0.33.5",
Copy link
Contributor Author

Choose a reason for hiding this comment

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

This seemed to be needed when I build it locally

@sblausten sblausten changed the title Move Scaffolder docs around a bit Improve scaffolder docs Dec 3, 2024
- Custom Scaffolder Parameters: '/docs/scaffolder/custom-fields/'
- Organising Templates: '/docs/scaffolder/certified-templates/'
Copy link
Contributor Author

Choose a reason for hiding this comment

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

This was missing from nav

- Scaffolder Parameters:
- Paremeters Guide: '/docs/scaffolder/scaffolder-parameters'
- Custom Scaffolder Parameters: '/docs/scaffolder/custom-fields/'
- Actions Directory: '/docs/scaffolder/scaffolder-actions-directory/'
Copy link
Contributor Author

@sblausten sblausten Dec 3, 2024

Choose a reason for hiding this comment

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

Flattening these as they are not deep enough to warrent being hidden behind additional click

- Debug template: '/docs/scaffolder/recipes/debug-template/'
- Append file: '/docs/scaffolder/recipes/append/'
- Re-use parameters: '/docs/scaffolder/recipes/global-constants/'
- Re-use steps: '/docs/scaffolder/recipes/placeholders/'
Copy link
Contributor Author

Choose a reason for hiding this comment

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

Adding this

@@ -1,12 +1,25 @@
---
title: Certified Templates
title: Organising Templates
Copy link
Contributor Author

Choose a reason for hiding this comment

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

Repurposing this for a more general page

@sblausten sblausten requested a review from a team December 3, 2024 11:08
Copy link

sonarcloud bot commented Dec 3, 2024

@sblausten sblausten merged commit f471a61 into main Dec 4, 2024
7 checks passed
@sblausten sblausten deleted the scaffolder-page-changes branch December 4, 2024 10:11
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.

2 participants