Skip to content

Commit 24ccf12

Browse files
committed
Create a demo documentation site
1 parent cb371b0 commit 24ccf12

File tree

2 files changed

+118
-0
lines changed

2 files changed

+118
-0
lines changed

.github/workflows/pages.yml

Lines changed: 70 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,70 @@
1+
# This workflow uses actions that are not certified by GitHub.
2+
# They are provided by a third-party and are governed by
3+
# separate terms of service, privacy policy, and support
4+
# documentation.
5+
6+
# Sample workflow for building and deploying a Jekyll site to GitHub Pages
7+
name: Deploy Jekyll site to Pages
8+
9+
on:
10+
push:
11+
branches: ["main"]
12+
paths:
13+
- "docs/**"
14+
15+
# Allows you to run this workflow manually from the Actions tab
16+
workflow_dispatch:
17+
18+
# Sets permissions of the GITHUB_TOKEN to allow deployment to GitHub Pages
19+
permissions:
20+
contents: read
21+
pages: write
22+
id-token: write
23+
24+
# Allow one concurrent deployment
25+
concurrency:
26+
group: "pages"
27+
cancel-in-progress: true
28+
29+
jobs:
30+
# Build job
31+
build:
32+
runs-on: ubuntu-latest
33+
defaults:
34+
run:
35+
working-directory: docs
36+
steps:
37+
- name: Checkout
38+
uses: actions/checkout@v3
39+
- name: Setup Ruby
40+
uses: ruby/setup-ruby@v1
41+
with:
42+
ruby-version: '3.1' # Not needed with a .ruby-version file
43+
bundler-cache: true # runs 'bundle install' and caches installed gems automatically
44+
cache-version: 0 # Increment this number if you need to re-download cached gems
45+
working-directory: '${{ github.workspace }}/docs'
46+
- name: Setup Pages
47+
id: pages
48+
uses: actions/configure-pages@v3
49+
- name: Build with Jekyll
50+
# Outputs to the './_site' directory by default
51+
run: bundle exec jekyll build --baseurl "${{ steps.pages.outputs.base_path }}"
52+
env:
53+
JEKYLL_ENV: production
54+
- name: Upload artifact
55+
# Automatically uploads an artifact from the './_site' directory by default
56+
uses: actions/upload-pages-artifact@v1
57+
with:
58+
path: "docs/_site/"
59+
60+
# Deployment job
61+
deploy:
62+
environment:
63+
name: github-pages
64+
url: ${{ steps.deployment.outputs.page_url }}
65+
runs-on: ubuntu-latest
66+
needs: build
67+
steps:
68+
- name: Deploy to GitHub Pages
69+
id: deployment
70+
uses: actions/deploy-pages@v2

docs/Fluent-React-Charting.md

Lines changed: 48 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,48 @@
1+
Fluent UI React (formerly Office UI Fabric React) charts is a set of modern, accessible, interactive and highly customizable visualization library representing the Microsoft design system.
2+
3+
The charting library is built using D3 (Data Driven Documents) and other fluent UI controls.
4+
5+
These charts are used across different products in Microsoft. They are ready to be used in a production environment.
6+
7+
**Overview deck:**
8+
https://microsoft.sharepoint.com/:p:/t/EDIndiaAmplifyTeam/EUK4BEYu5aROh41rAK4ci9UBmRKvuH9aTcMcQuq0qUAKbg?e=7zpXdU
9+
10+
**POC:**
11+
**Engineering:** Sasidhar Kasi (PM), Rohit Srivastava (EM), Atishay Jain (Engg)
12+
**Design:** Kari Strand, Karina Dion, Carrie Cosgrove Claire Goetschel
13+
14+
**Request intake form:**
15+
https://aka.ms/fluentChartingPartnerRequest
16+
17+
**Reporting Bugs**
18+
https://uifabric.visualstudio.com/iss/_workitems/create/Bug?templateId=77f0176a-a9a5-41f7-a8d2-3901764351f3&ownerId=0c0ad9a8-059c-4697-a4b6-ff1179ca8699
19+
20+
**Queries**
21+
For any queries reach out to our teams channel: https://teams.microsoft.com/l/team/19%3a5a4c94a9492146e8b3a69a9702af9dd7%40thread.tacv2/conversations?groupId=bd4ecd7a-4fbb-4368-8b78-f36d035ba5f8&tenantId=72f988bf-86f1-41af-91ab-2d7cd011db47
22+
or
23+
Add a tag _#fluent-charting_ while posting a message in [stack overflow](https://stackoverflow.microsoft.com/search?q=%5Bfluent-charting%5D)
24+
or
25+
You can also post your issues directly on [github](https://github.com/microsoft/fluentui/issues)
26+
27+
Our team tracks these channels regularly and replies within a day.
28+
29+
**Detailed documentation:**
30+
https://github.com/microsoft/fluentui/blob/master/packages/react-charting/README.md
31+
32+
**Demo site:**
33+
https://aka.ms/fluentcharting
34+
35+
**Code repository:**
36+
https://github.com/microsoft/fluentui/blob/master/packages/react-charting
37+
38+
**DataViz design guidelines**
39+
https://www.figma.com/file/WOoCs0CmNYZhYl9xXeCGpi/Data-viz
40+
41+
**Reporting Incidents**
42+
Here is our IcM team details to log incidents https://portal.microsofticm.com/imp/v3/administration/teamdashboard/details?id=104832.
43+
44+
**Current backlog**
45+
https://uifabric.visualstudio.com/iss/_backlogs/backlog/Fluent%20React%20Charting%20Engineering/Stories
46+
47+
**Published roadmap**
48+
https://github.com/orgs/microsoft/projects/792/views/1

0 commit comments

Comments
 (0)