pnp
Major refresh 2024/2025/2026
I am thinking of a major refresh to the UI/Site for Script Samples.
UI
- New Theme - Currently, I am working on a skin for DocFx in the format of the main pnp.github.io site - WIP is here: https://pkbullock.github.io/pnp-docfx-theme/ its not finished but visually could look like the new site.
- List view - have a view to see all the scripts in a list rather than card view.
- Tabs - I'm thinking of moving away from the tab experience and having all the scripts within the page, perhaps with jump links e.g. for those samples, with PnP Powershell, Cli for Microsoft 365 etc.
- Script Category Refresh e.g. Intranet, DMS, Search Project, Copilot, Security, to better see what scripts are available by users intended project. This will need to align in some part with the adoption gallery.
Contributor Experience
I'm thinking of ways to lower the barrier to contribution
- Contributor guidance refresh
- Video examples
- Even considering a UI experience to collect the script and visually generate the page, then on save, create a PR.
- At the moment, I am the only one who can see if the pages/site generates as expected, which isn't optimal, something I do manually and locally. I might see what can be done about a "preview" of the site or sample with your submission.
- Optionally, have a request to generate the description of the script using AI.
Sample Checking
- This one might be challenging but to check, and refresh samples to the latest versions of their samples (or have a tested new tweaked sample) I wonder based on sample complexity which ones can be "automated" vs manual due to very specific setup.
Ref Issues that might feed into this: #638, #681, #522, #511, #284, #182, #95 and try incorporate or make redundant these issues.
Open to all to comment, if there is something you would like to see.
CC: @reshmee011, @kasperbolarsen, @chandaniprajapati, @ValerasNarbutas - just wondering what your thoughts are, or things you would like to see.
hi @pkbullock ,
- to be fare i really like clean theme we have now, but i do agree it would be better to have consistent theme.
- On tabs or jump links both are quite good, as long as we still have it as separate code snippet in view,
- Contributor experience is quite good at least when i show it to some potential contributors, feedback is good.
- List view would be also great, (for me boxes also very convenient ), List view like this https://pnp.github.io/script-samples/matrix.html is nice, just filter options on headers would be something i miss
I do not really have any comments on improvements, script-samples already one of the most clear displays. Very easy to the eye, intuitive UI.
Happy to help on improvements by the way, Valeras
Hi @ValerasNarbutas - thank you for your really great feedback, and thank you for sharing your experiences with myself and other potential contributors, really cool.
The theme is quite a bit of work, so might consider your inputs, the new one is certainly different, so need to think about readability, simplicity etc. Its likely not the first (if any) improvement I would make.
The matrix link was a quick view for me to assess sample coverage and qualities for the community calls, but I see your point there. Thank you.
Appreciate the input 🤩
To remove the dependency on the pluginm two things need to change:
- PowerShell equivelant of consolidating the sample.json files into samples.json for the root of the site
- The clipboard icon, can be injected in with JavaScript into the target locations.
This should then UNLOCK the ability to upgrade DocFx.
UI Issue to fix, on Safari MAC (Yippee, I can test on a Mac now), the tool icons are mis-aligned: