microsoft / dstoolkit-web

Repository for the Data Science Toolkit website

git repo for the GitHub Pages site for the Microsoft Data Science Toolkit.

Overview of git repo:

The main branch for the GitHub pages site is "gh-pages"

The skeleton template file to be copied and modified for future Delivery Accelerator pages is: DEMO-SingleAcceleratorPage.md

To read more about how to create a new accelerator page, please see the guide HowToCreateAcceleratorPage.

Folders:

• (n/a - root directory) - contains the .md files for the pages of the site
• scripts - contains all of the custom JavaScript for the site
• images - contains all of the images used in the site
• css - contains all of the custom CSS for the site

Contributing

This project welcomes contributions and suggestions. Most contributions require you to agree to a Contributor License Agreement (CLA) declaring that you have the right to, and actually do, grant us the rights to use your contribution. For details, visit https://cla.opensource.microsoft.com.

When you submit a pull request, a CLA bot will automatically determine whether you need to provide a CLA and decorate the PR appropriately (e.g., status check, comment). Simply follow the instructions provided by the bot. You will only need to do this once across all repos using our CLA.

This project has adopted the Microsoft Open Source Code of Conduct. For more information see the Code of Conduct FAQ or contact [email protected] with any additional questions or comments.

Trademarks

This project may contain trademarks or logos for projects, products, or services. Authorized use of Microsoft trademarks or logos is subject to and must follow Microsoft's Trademark & Brand Guidelines. Use of Microsoft trademarks or logos in modified versions of this project must not cause confusion or imply Microsoft sponsorship. Any use of third-party trademarks or logos are subject to those third-party's policies.

dstoolkit-web's Issues

Updating the home page headline photo and description

1. Home page headline photo should be replaced with the photo from the Toolkit page
2. Home page description should be replaced with the Toolkit description
3. this means that the tool kit starts with "Delivery Accelerators Repository"
   NOTE: Repository should be singular.
   a

I'll send a summary email to Karsten with photos

footer should be updated per final UI design for v1

Forecasting accelerator page repo links are to private DevOps repo

Need to confirm a Cela and privacy review before publishing

Forecasting accelerator description may not be correct

I believe the forecasting accelerator is useful in demand forecasting, revenue forecasting, cash flow forecasting, .... any time series forecasting... need to confirm with Willie/Karsten.

accelerator pages - the title 'Use Cases" should be plural when there are more than one use case

Single Accelerator Pages: add Github widgets/quick action buttons

add links to watch, fork and star for each delivery accelerator's git repo

these are the default buttons when a user doesn't have direct access to a repo:
Notifications
Fork
Star

But there is no official documentation from Github on integrating the Github quick action buttons and functionality. There are only unofficial, custom solutions online such as https://buttons.github.io/

Contributors Page: Update Solution Accelerator Contributors to "Solution Delivery Accelerator Contributors"

Contributors Page: Update Solution Accelerator Contributors to "Solution Delivery Accelerator Contributors"

finish How I can contribute page

Accelerator Pages - Prerequisites should be simple bullet pointed list

‘prerequisites’ be a simple list of bullet points, especially if there are not any links to the referenced items. The reason being that this view is so ‘pretty’ that it looks like we are describing the features/benefits of this accelerator.

Accelerator pages - the detailed 'Accelerator Description' should come from the global announcement

Thus all detailed descriptions will have a common 'voice'.

Single Accelerator Page: Update ML Ops Solutions Accelerator to: "ML Ops Solution Delivery Accelerator"

Single Accelerator Page: Update ML Ops Solutions Accelerator to: "ML Ops Solution Delivery Accelerator"

for Toolkit page, Remove ? from "Data Science Toolkit?"

Toolkit page/Toolkit Page Filter - filter: Remove ? from "Data Science Toolkit?"

link to conversation ai header image broken

recommended common UI template for Accelerator pages - simplified, clean

I've drafted something in PPT to illustrate what I mean here and I'm sharing it with Karsten. There do not need to be many photos on these pages, but there may need to be clear delineation between topics, perhaps by grouping in boxes with slim lines. The photo at the top is good, then the call to action should be impactful and so should include a smaller photo.

build warnings after completion of PR#8

ISSUE: build warnings after completion of PR#8 (#8)

FIX: Remove the 'markdown' setting per GitHub notification below:

add the colors from wireframes to all the pages

Get in Touch Box needs to be revised

The Get in touch box needs to be a bit more personal and more clear. I've drafted a UI and sent over email.

Contributors page and contributors listed on each accelerator page should have pictures

pictures should be pulled in dynamically from github based on the contributor's github alias so that it is in sync with whichever photo they choose to upload (or not) for their Github account

Related to #36

we will need to create custom scripts that leverage the public github api to retrieve information about the contributors for the git repo for a delivery accelerator page, parse the JSON request, and display that information, filtering out the following bot accounts:
microsoft-github-operations[bot]
microsoftopensource
dependabot[bot]

toolkit page: include placeholder functionality

for the filters and "see more" button to show the V1 design

are all the YouTube videos uploaded okay to post publicly?

Add hyperlink to DS toolkit logo

Would it be possible to add the link to the DS toolkit logo on top of the navigation bar, so that when you press it you would be redirected automatically to the Home page? This is to improve the user experience because sometimes it comes automatic to me to press on either the logo or the title of the website to go to the Home page, instead of clicking directly on "Home"

Contributors Page: filtering functionality and dynamic loading of contributors

filter contributors based on the accelerator they contributed to

should get list of repos "accelerators" by searching for contributors part of git repos tagged with "dstoolkit" and then use this to filter the list of contributors displayed (see comments from issue #42 )

to store information about the list of contributors and accelerators, try leveraging the web storage API (https://developer.mozilla.org/en-US/docs/Web/API/Web_Storage_API/Using_the_Web_Storage_API) or IndexedDB API (https://developer.mozilla.org/en-US/docs/Web/API/IndexedDB_API) for client-side session storage

Home Page/Use the Toolkit

change "push button" to "easy button"

Bottom Grey Banner too narrow (footer)

Would it be possible to make the grey section with "Contact, Trademarks, Microsoft etc." wider? So that it is the same length as the top navigation bar? The one in red:

ML Ops accelerator page

ISSUE 1: iframe code is showing on this page

ISSUE 2:
links on the page aren't clickable and appear as checkboxes:

Home page: update Contact form

for this contact form on Home page,

update the list and order for "User type":

and "Customer" is selected by default

remove old footer

per final UI designs

GitHub aliases for Contributors

(pendingClient) Github aliases for all the Contributors on each delivery accelerator page, and also the Contributors page?

then will need to update all pages to have Github aliases

favicon.ico not found when building site locally

update description for Home page

How to contribute page collapsing agenda

The agenda/legend is not well aligned

home.md and index.md pages are duplicates of each other

update format for remaining 8 accelerator pages

based on template page file, TEMPLATE-SingleAcceleratorPage.md

Recommend we have CELA and Privacy review this site.

Recommend we have CELA and Privacy review this site.

Single Accelerator page: ensure known Microsoft products and services websites are linked

under Technologies

Image + Text -- Data Science Tookit

Make text part of image for logo up top - if you narrow the size of the window, then the text wraps - which does not look good.

Header of website & Data Science Toolkit logo

the DSTK logo image needs to include the words 'Data Science Toolkit'. right now these words are text and they will wrap if the window is minimized.

navbar should highlight the current page being viewed

when applicable

accelerator pages - industries served should be a bullet pointed list

this will make it cleaner and easier to read

On the toolkit page, the 'filter by..' buttons should be pre-defined

a. FYI: the ‘filter by technology’ and filter by domain are not functioning, though you probably know that . My recommendation is that these be pre-set so folks choose from a list, rather than enable them to search for anything

create new template .md file for Single Accelerator Pages

call it TEMPLATE-SingleAcceleratorPage.md

Microsoft links should be added to footer

Contact Microsoft: https://support.microsoft.com/contactus
Privacy: https://go.microsoft.com/fwlink/?LinkId=521839
Manage cookies: TBD
Terms of use: https://go.microsoft.com/fwlink/?LinkID=206977
Trademarks: https://www.microsoft.com/trademarks
About our ads: https://choice.microsoft.com/

update and add remaining content for all delivery accelerator pages

update and add content for all pages, including all accelerator pages

Home/Contribute

Question - do we want to say "...for your customer"? Combined with the use of "IP" this might look like we are suggesting people bring IP that might belong to the customer.

for the images added, need to replace the ones from Shutterstock

for the images added, need to replace the ones from Shutterstock

Originally posted by @mtran-affirma in #47 (review)

Single Accelerator Page: enable collapsing functionality

enable collapsing functionality Architecture, Branching Strategy, and Accelerator Components sections on each Single Accelerator Page

Home page: add fourth option for "Microsoft Employee" #71

toolkit page

1. remove the photo to home page
2. replace the text with: "You can contribute new accelerators, update existing accelerators, or simply use the accelerators below."
3. When any given accelerator link is clicked, the accelerator should open in a new page.

Remove Headline on Home page

Suggest we remove the Headline (What is the Data Science Toolkit?). It uses space and does not add value given the text block will cover the topic.