Skip to content

Commit beefad9

Browse files
sympmarcsympmarc
committed
Add DocFX site
1 parent fe7a961 commit beefad9

4 files changed

Lines changed: 170 additions & 15 deletions

File tree

‎docs/_site/docs/index.html‎

Lines changed: 155 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,155 @@
1+
<!DOCTYPE html>
2+
<!--[if IE]><![endif]-->
3+
<html>
4+
5+
<head>
6+
<meta charset="utf-8">
7+
<meta http-equiv="X-UA-Compatible" content="IE=edge,chrome=1">
8+
<title>PnP Core SDK | Maturity Model for microsoft 365 </title>
9+
<meta name="viewport" content="width=device-width">
10+
<meta name="title" content="PnP Core SDK | Maturity Model for microsoft 365 ">
11+
12+
13+
<link rel="shortcut icon" href="../favicon.ico">
14+
<link rel="stylesheet" href="../styles/docfx.vendor.min.css">
15+
<link rel="stylesheet" href="../styles/docfx.css">
16+
<link rel="stylesheet" href="../styles/main.css">
17+
<meta property="docfx:navrel" content="../toc.html">
18+
<meta property="docfx:tocrel" content="toc.html">
19+
20+
<meta property="docfx:rel" content="../">
21+
22+
</head>
23+
<body data-spy="scroll" data-target="#affix" data-offset="120">
24+
<div id="wrapper">
25+
<header>
26+
27+
<nav id="autocollapse" class="navbar navbar-inverse ng-scope" role="navigation">
28+
<div class="container">
29+
<div class="navbar-header">
30+
<button type="button" class="navbar-toggle" data-toggle="collapse" data-target="#navbar">
31+
<span class="sr-only">Toggle navigation</span>
32+
<span class="icon-bar"></span>
33+
<span class="icon-bar"></span>
34+
<span class="icon-bar"></span>
35+
</button>
36+
37+
<a class="navbar-brand" href="../index.html">
38+
<img id="logo" class="svg" src="../logo.svg" alt="Maturity Model for microsoft 365">
39+
</a>
40+
</div>
41+
<div class="collapse navbar-collapse" id="navbar">
42+
<form class="navbar-form navbar-right" role="search" id="search">
43+
<div class="form-group">
44+
<input type="text" class="form-control" id="search-query" placeholder="Search" autocomplete="off">
45+
</div>
46+
</form>
47+
</div>
48+
</div>
49+
</nav>
50+
51+
<div class="subnav navbar navbar-default">
52+
<div class="container hide-when-search" id="breadcrumb">
53+
<ul class="breadcrumb">
54+
<li></li>
55+
</ul>
56+
</div>
57+
</div>
58+
</header>
59+
<div class="container body-content">
60+
61+
<div id="search-results">
62+
<div class="search-list">Search Results for <span></span></div>
63+
<div class="sr-items">
64+
<p><i class="glyphicon glyphicon-refresh index-loading"></i></p>
65+
</div>
66+
<ul id="pagination" data-first=First data-prev=Previous data-next=Next data-last=Last></ul>
67+
</div>
68+
</div>
69+
<div role="main" class="container body-content hide-when-search">
70+
71+
<div class="sidenav hide-when-search">
72+
<a class="btn toc-toggle collapse" data-toggle="collapse" href="#sidetoggle" aria-expanded="false" aria-controls="sidetoggle">Show / Hide Table of Contents</a>
73+
<div class="sidetoggle collapse" id="sidetoggle">
74+
<div id="sidetoc"></div>
75+
</div>
76+
</div>
77+
<div class="article row grid-right">
78+
<div class="col-md-10">
79+
<article class="content wrap" id="_content" data-uid="">
80+
<h1 id="pnp-core-sdk">PnP Core SDK</h1>
81+
82+
<h2 id="intro">Intro</h2>
83+
<p>The PnP Core SDK is an SDK designed to work for Microsoft 365. It provides a unified object model for working with SharePoint Online and Teams which is agnostic to the underlying APIs being called. The initial goal for this library will be to cover the needs of developers working with either SharePoint Online or Teams, but we're also open to extend this library further towards other Microsoft 365 workloads if there's community demand for doing so.</p>
84+
<div class="IMPORTANT">
85+
<h5>Important</h5>
86+
<ul>
87+
<li>If you've used PnP Core SDK in a version before Beta3 then please check <a href="https://pnp.github.io/pnpcore/using-the-sdk/upgrade-to-beta3.html">these instructions</a> on how to upgrade your code to the current version.</li>
88+
</ul>
89+
</div>
90+
<h2 id="getting-started-using-this-library">Getting started using this library</h2>
91+
<p>Using the PnP Core SDK is simple, check out the <a href="./using-the-sdk/readme.md">getting started</a> guide.</p>
92+
<h2 id="where-is-the-code">Where is the code?</h2>
93+
<p>The PnP Core SDK is maintained in the PnP GitHub repository: <a href="https://github.com/pnp/pnpcore">https://github.com/pnp/pnpcore</a>.</p>
94+
<h2 id="supportability-and-sla">Supportability and SLA</h2>
95+
<p>This library is open-source and community provided component with active community providing support for it. This is not Microsoft provided component so there's no SLA or direct support for this open-source component from Microsoft. Please report any issues using the <a href="https://github.com/pnp/pnpcore/issues">issues list</a>.</p>
96+
<h2 id="how-can-you-help">How can you help?</h2>
97+
<p>The model implemented in the preview only covers a small part of what's possible and what's needed. We're asking the community to help us expand the model by:</p>
98+
<ul>
99+
<li><strong>Extending the model</strong> via the creation of new model, complex type and collection classes. Check out the <a href="../contributing/readme.md">Extending the model</a> article to learn how to do this.</li>
100+
<li><strong>Adding &quot;functionalities&quot;</strong> to the model: after extending the model, the typical CRUD functionality is there, but for some parts of the model it makes sense to add functionalities by adding methods on top of the model classes. Check out the <a href="../contributing/readme.md">Extending the model</a> article to learn how to do this.</li>
101+
<li><strong>Writing sample programs</strong> that use this library: since this is a .Net Standard library, it doesn't target Windows only, but also macOS and Linux, as well as mobile OS's like Android and iOS. With the rise of <a href="https://dotnet.microsoft.com/apps/aspnet/web-apps/blazor">Blazor</a>, this library can also be used to build .Net based apps running in the browser. Samples can be added in the <a href="https://github.com/pnp/pnpcore/tree/dev/samples">samples</a> folder.</li>
102+
<li><strong>Working on documentation</strong>: good documentation is critical to help developers work with this library, either by using it or by extending it. See the <a href="../contributing/writing%20documentation.md">Writing documentation</a> article for more details.</li>
103+
</ul>
104+
<h3 id="best-practices-when-contributing">Best practices when contributing</h3>
105+
<ul>
106+
<li>This is all new and we're here to help, don't hesitate to reach out with your questions and feedback via <a href="https://github.com/pnp/pnpcore/issues">our issue list</a> or <a href="https://github.com/pnp/pnpcore/discussions">our discussions</a>.</li>
107+
<li>To avoid overlapping efforts in the startup phase please let us know if you plan to take on a particular chunk of work (e.g. let's say you want to extend the model to support Planner)</li>
108+
<li>If you are extending the model and you need to update the model base logic then please reach out, we want to align and agree on those changes first as these need to fit into our model approach</li>
109+
</ul>
110+
<div class="NOTE">
111+
<h5>Note</h5>
112+
<p>The best way to reach out is by creating an issue in the issue list: <a href="https://github.com/pnp/pnpcore/issues">https://github.com/pnp/pnpcore/issues</a></p>
113+
</div>
114+
<p><strong>This community rocks, sharing is caring!</strong></p>
115+
116+
</article>
117+
</div>
118+
119+
<div class="hidden-sm col-md-2" role="complementary">
120+
<div class="sideaffix">
121+
<div class="contribution">
122+
<ul class="nav">
123+
<li>
124+
<a href="https://github.com/pnp/maturity-model/blob/main/docs/docs/index.md/#L1" class="contribution-link">Edit this page</a>
125+
</li>
126+
</ul>
127+
</div>
128+
<nav class="bs-docs-sidebar hidden-print hidden-xs hidden-sm affix" id="affix">
129+
<h5>In this article</h5>
130+
<div></div>
131+
</nav>
132+
</div>
133+
</div>
134+
</div>
135+
</div>
136+
137+
<footer>
138+
<div class="grad-bottom"></div>
139+
<div class="footer">
140+
<div class="container">
141+
<span class="pull-right">
142+
<a href="#top">Back to top</a>
143+
</span>
144+
145+
<span>Generated by <strong>DocFX</strong></span>
146+
</div>
147+
</div>
148+
</footer>
149+
</div>
150+
151+
<script type="text/javascript" src="../styles/docfx.vendor.min.js"></script>
152+
<script type="text/javascript" src="../styles/docfx.js"></script>
153+
<script type="text/javascript" src="../styles/main.js"></script>
154+
</body>
155+
</html>

‎docs/_site/index.json‎

Lines changed: 5 additions & 5 deletions
Large diffs are not rendered by default.

‎docs/_site/manifest.json‎

Lines changed: 10 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -60,6 +60,16 @@
6060
},
6161
"version": ""
6262
},
63+
{
64+
"type": "Conceptual",
65+
"source_relative_path": "docs/index.md",
66+
"output": {
67+
".html": {
68+
"relative_path": "docs/index.html"
69+
}
70+
},
71+
"version": ""
72+
},
6373
{
6474
"type": "Resource",
6575
"source_relative_path": "docs/media/maturity-model-for-microsoft-365/M365MM.png",
@@ -173,16 +183,6 @@
173183
},
174184
"version": ""
175185
},
176-
{
177-
"type": "Conceptual",
178-
"source_relative_path": "index.md",
179-
"output": {
180-
".html": {
181-
"relative_path": "index.html"
182-
}
183-
},
184-
"version": ""
185-
},
186186
{
187187
"type": "Toc",
188188
"source_relative_path": "toc.yml",

docs/index.md renamed to docs/docs/index.md

File renamed without changes.

0 commit comments

Comments
 (0)