Add missing documentation.

This commit is contained in:
2018-12-29 13:29:44 +00:00
parent 49d6f9e7dd
commit fc4bfad044
9 changed files with 470 additions and 0 deletions

View File

@@ -1862,9 +1862,13 @@
</e>
<e p="Views" t="Include">
<e p="Home" t="Include">
<e p="CODE_OF_CONDUCT.cshtml" t="Include" />
<e p="CONTRIBUTING.cshtml" t="Include" />
<e p="Changelog.cshtml" t="Include" />
<e p="DONATING.cshtml" t="Include" />
<e p="ISSUE_TEMPLATE.cshtml" t="Include" />
<e p="Index.cshtml" t="Include" />
<e p="PULL_REQUEST_TEMPLATE.cshtml" t="Include" />
<e p="TODO.cshtml" t="Include" />
</e>
<e p="Report" t="Include">
@@ -1880,8 +1884,10 @@
<e p="Web.config" t="Include" />
<e p="bin" t="ExcludeRecursive" />
<e p="docs" t="Include">
<e p="CONTRIBUTING.md" t="Include" />
<e p="Changelog.md" t="Include" />
<e p="DONATING.md" t="Include" />
<e p="NEEDINFO.md" t="Include" />
<e p="README.md" t="Include" />
<e p="TODO.md" t="Include" />
</e>

View File

@@ -43,6 +43,74 @@ namespace DiscImageChef.Server.Controllers
return View();
}
public ActionResult CODE_OF_CONDUCT()
{
StreamReader sr =
new StreamReader(Path.Combine(HostingEnvironment.MapPath("~") ?? throw new InvalidOperationException(),
"docs", "CODE_OF_CONDUCT.md"));
string mdcontent = sr.ReadToEnd();
sr.Close();
mdcontent = mdcontent.Replace(".md)", ")").Replace("(.github/", "(");
ViewBag.Markdown = Markdown.ToHtml(mdcontent);
ViewBag.lblVersion = Assembly.GetExecutingAssembly().GetName().Version.ToString();
return View();
}
public ActionResult PULL_REQUEST_TEMPLATE()
{
StreamReader sr =
new StreamReader(Path.Combine(HostingEnvironment.MapPath("~") ?? throw new InvalidOperationException(),
"docs", "PULL_REQUEST_TEMPLATE.md"));
string mdcontent = sr.ReadToEnd();
sr.Close();
mdcontent = mdcontent.Replace(".md)", ")").Replace("(.github/", "(");
ViewBag.Markdown = Markdown.ToHtml(mdcontent);
ViewBag.lblVersion = Assembly.GetExecutingAssembly().GetName().Version.ToString();
return View();
}
public ActionResult ISSUE_TEMPLATE()
{
StreamReader sr =
new StreamReader(Path.Combine(HostingEnvironment.MapPath("~") ?? throw new InvalidOperationException(),
"docs", "ISSUE_TEMPLATE.md"));
string mdcontent = sr.ReadToEnd();
sr.Close();
mdcontent = mdcontent.Replace(".md)", ")").Replace("(.github/", "(");
ViewBag.Markdown = Markdown.ToHtml(mdcontent);
ViewBag.lblVersion = Assembly.GetExecutingAssembly().GetName().Version.ToString();
return View();
}
public ActionResult CONTRIBUTING()
{
StreamReader sr =
new StreamReader(Path.Combine(HostingEnvironment.MapPath("~") ?? throw new InvalidOperationException(),
"docs", "CONTRIBUTING.md"));
string mdcontent = sr.ReadToEnd();
sr.Close();
mdcontent = mdcontent.Replace(".md)", ")").Replace("(.github/", "(");
ViewBag.Markdown = Markdown.ToHtml(mdcontent);
ViewBag.lblVersion = Assembly.GetExecutingAssembly().GetName().Version.ToString();
return View();
}
public ActionResult DONATING()
{
StreamReader sr =

View File

@@ -276,7 +276,9 @@
</ItemGroup>
<ItemGroup>
<Content Include="docs\Changelog.md" />
<Content Include="docs\CONTRIBUTING.md" />
<Content Include="docs\DONATING.md" />
<Content Include="docs\NEEDINFO.md" />
<Content Include="docs\README.md" />
<Content Include="docs\TODO.md" />
<Content Include="dos.css" />
@@ -297,7 +299,11 @@
<Content Include="styles\_highcharts.scss" />
<Content Include="styles\_vgafont.scss" />
<Content Include="Views\Home\Changelog.cshtml" />
<Content Include="Views\Home\CODE_OF_CONDUCT.cshtml" />
<Content Include="Views\Home\CONTRIBUTING.cshtml" />
<Content Include="Views\Home\DONATING.cshtml" />
<Content Include="Views\Home\ISSUE_TEMPLATE.cshtml" />
<Content Include="Views\Home\PULL_REQUEST_TEMPLATE.cshtml" />
<Content Include="Views\Home\TODO.cshtml" />
<Content Include="Views\Report\View.cshtml" />
<Content Include="Web.config" />

View File

@@ -0,0 +1,97 @@
@{
ViewBag.Title = "DiscImageChef";
}
@{
/***************************************************************************
The Disc Image Chef
----------------------------------------------------------------------------
Filename : DONATING.aspx
Author(s) : Natalia Portillo <claunia@claunia.com>
Component : DiscImageChef Server.
--[ Description ] ----------------------------------------------------------
Renders DONATING.md.
--[ License ] --------------------------------------------------------------
This library is free software; you can redistribute it and/or modify
it under the terms of the GNU Lesser General Public License as
published by the Free Software Foundation; either version 2.1 of the
License, or (at your option) any later version.
This library is distributed in the hope that it will be useful, but
WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
Lesser General Public License for more details.
You should have received a copy of the GNU Lesser General Public
License along with this library; if not, see <http://www.gnu.org/licenses/>.
----------------------------------------------------------------------------
Copyright © 2011-2018 Natalia Portillo
****************************************************************************/
}
<!DOCTYPE html>
<html>
<meta charset="UTF-8">
<head>
<link href="../../styles/dicserver.css"
rel="stylesheet"type="text/css" />
<link href="../../styles/dicserver_highcharts.css"
rel="stylesheet"type="text/css" />
<title>@ViewBag.Title</title>
<meta charset="utf-8" />
<!-- Global site tag (gtag.js) - Google Analytics -->
<script async
src="https://www.googletagmanager.com/gtag/js?id=UA-111466173-1"></script>
<script>
window.dataLayer = window.dataLayer || [];
function gtag() { dataLayer.push(arguments); }
gtag('js', new Date());
gtag('config', 'UA-111466173-1');
</script>
</head>
<body>
<p>
@Html.ActionLink("Return to main page.", "Index")<br />
DiscImageChef's code of conduct:
</p>
<div class="container">@Html.Raw(ViewBag.Markdown)</div>
<footer class="container-fluid">
© 2011-2018
<a href="http://www.claunia.com"
target="_blank">
Claunia.com
</a><br />
Fonts are © 2015-2016
<a href="http://int10h.org"
target="_blank">
VileR
</a><br />
CSS © 2018
<a href="https://getbootstrap.com/"
target="_blank">
Bootstrap
</a> and
<a href="http://www.claunia.com"
target="_blank">
Claunia.com
</a>
</footer>
<script crossorigin="anonymous"
integrity="sha384-q8i/X+965DzO0rT7abK41JStQIAqVgRVzpbzo5smXKp4YfRvH+8abtTE1Pi6jizo"
src="https://code.jquery.com/jquery-3.3.1.slim.min.js"></script>
<script crossorigin="anonymous"
integrity="sha384-wHAiFfRlMFy6i5SRaxvfOCifBUQy1xHdJ/yoi7FRNXMRBu5WHdZYu1hA6ZOblgut"
src="https://cdnjs.cloudflare.com/ajax/libs/popper.js/1.14.6/umd/popper.min.js"></script>
<script crossorigin="anonymous"
integrity="sha384-B0UglyR+jN6CkvvICOB2joaf5I4l3gm9GU6Hc1og6Ls7i6U/mkkaduKaBhlAXv9k"
src="https://stackpath.bootstrapcdn.com/bootstrap/4.2.1/js/bootstrap.min.js"></script>
</body>
</html>

View File

@@ -0,0 +1,97 @@
@{
ViewBag.Title = "DiscImageChef";
}
@{
/***************************************************************************
The Disc Image Chef
----------------------------------------------------------------------------
Filename : DONATING.aspx
Author(s) : Natalia Portillo <claunia@claunia.com>
Component : DiscImageChef Server.
--[ Description ] ----------------------------------------------------------
Renders DONATING.md.
--[ License ] --------------------------------------------------------------
This library is free software; you can redistribute it and/or modify
it under the terms of the GNU Lesser General Public License as
published by the Free Software Foundation; either version 2.1 of the
License, or (at your option) any later version.
This library is distributed in the hope that it will be useful, but
WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
Lesser General Public License for more details.
You should have received a copy of the GNU Lesser General Public
License along with this library; if not, see <http://www.gnu.org/licenses/>.
----------------------------------------------------------------------------
Copyright © 2011-2018 Natalia Portillo
****************************************************************************/
}
<!DOCTYPE html>
<html>
<meta charset="UTF-8">
<head>
<link href="../../styles/dicserver.css"
rel="stylesheet"type="text/css" />
<link href="../../styles/dicserver_highcharts.css"
rel="stylesheet"type="text/css" />
<title>@ViewBag.Title</title>
<meta charset="utf-8" />
<!-- Global site tag (gtag.js) - Google Analytics -->
<script async
src="https://www.googletagmanager.com/gtag/js?id=UA-111466173-1"></script>
<script>
window.dataLayer = window.dataLayer || [];
function gtag() { dataLayer.push(arguments); }
gtag('js', new Date());
gtag('config', 'UA-111466173-1');
</script>
</head>
<body>
<p>
@Html.ActionLink("Return to main page.", "Index")<br />
How to contribute to DiscImageChef:
</p>
<div class="container">@Html.Raw(ViewBag.Markdown)</div>
<footer class="container-fluid">
© 2011-2018
<a href="http://www.claunia.com"
target="_blank">
Claunia.com
</a><br />
Fonts are © 2015-2016
<a href="http://int10h.org"
target="_blank">
VileR
</a><br />
CSS © 2018
<a href="https://getbootstrap.com/"
target="_blank">
Bootstrap
</a> and
<a href="http://www.claunia.com"
target="_blank">
Claunia.com
</a>
</footer>
<script crossorigin="anonymous"
integrity="sha384-q8i/X+965DzO0rT7abK41JStQIAqVgRVzpbzo5smXKp4YfRvH+8abtTE1Pi6jizo"
src="https://code.jquery.com/jquery-3.3.1.slim.min.js"></script>
<script crossorigin="anonymous"
integrity="sha384-wHAiFfRlMFy6i5SRaxvfOCifBUQy1xHdJ/yoi7FRNXMRBu5WHdZYu1hA6ZOblgut"
src="https://cdnjs.cloudflare.com/ajax/libs/popper.js/1.14.6/umd/popper.min.js"></script>
<script crossorigin="anonymous"
integrity="sha384-B0UglyR+jN6CkvvICOB2joaf5I4l3gm9GU6Hc1og6Ls7i6U/mkkaduKaBhlAXv9k"
src="https://stackpath.bootstrapcdn.com/bootstrap/4.2.1/js/bootstrap.min.js"></script>
</body>
</html>

View File

@@ -0,0 +1,97 @@
@{
ViewBag.Title = "DiscImageChef";
}
@{
/***************************************************************************
The Disc Image Chef
----------------------------------------------------------------------------
Filename : DONATING.aspx
Author(s) : Natalia Portillo <claunia@claunia.com>
Component : DiscImageChef Server.
--[ Description ] ----------------------------------------------------------
Renders DONATING.md.
--[ License ] --------------------------------------------------------------
This library is free software; you can redistribute it and/or modify
it under the terms of the GNU Lesser General Public License as
published by the Free Software Foundation; either version 2.1 of the
License, or (at your option) any later version.
This library is distributed in the hope that it will be useful, but
WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
Lesser General Public License for more details.
You should have received a copy of the GNU Lesser General Public
License along with this library; if not, see <http://www.gnu.org/licenses/>.
----------------------------------------------------------------------------
Copyright © 2011-2018 Natalia Portillo
****************************************************************************/
}
<!DOCTYPE html>
<html>
<meta charset="UTF-8">
<head>
<link href="../../styles/dicserver.css"
rel="stylesheet"type="text/css" />
<link href="../../styles/dicserver_highcharts.css"
rel="stylesheet"type="text/css" />
<title>@ViewBag.Title</title>
<meta charset="utf-8" />
<!-- Global site tag (gtag.js) - Google Analytics -->
<script async
src="https://www.googletagmanager.com/gtag/js?id=UA-111466173-1"></script>
<script>
window.dataLayer = window.dataLayer || [];
function gtag() { dataLayer.push(arguments); }
gtag('js', new Date());
gtag('config', 'UA-111466173-1');
</script>
</head>
<body>
<p>
@Html.ActionLink("Return to main page.", "Index")<br />
DiscImageChef's template for issue reports:
</p>
<div class="container">@Html.Raw(ViewBag.Markdown)</div>
<footer class="container-fluid">
© 2011-2018
<a href="http://www.claunia.com"
target="_blank">
Claunia.com
</a><br />
Fonts are © 2015-2016
<a href="http://int10h.org"
target="_blank">
VileR
</a><br />
CSS © 2018
<a href="https://getbootstrap.com/"
target="_blank">
Bootstrap
</a> and
<a href="http://www.claunia.com"
target="_blank">
Claunia.com
</a>
</footer>
<script crossorigin="anonymous"
integrity="sha384-q8i/X+965DzO0rT7abK41JStQIAqVgRVzpbzo5smXKp4YfRvH+8abtTE1Pi6jizo"
src="https://code.jquery.com/jquery-3.3.1.slim.min.js"></script>
<script crossorigin="anonymous"
integrity="sha384-wHAiFfRlMFy6i5SRaxvfOCifBUQy1xHdJ/yoi7FRNXMRBu5WHdZYu1hA6ZOblgut"
src="https://cdnjs.cloudflare.com/ajax/libs/popper.js/1.14.6/umd/popper.min.js"></script>
<script crossorigin="anonymous"
integrity="sha384-B0UglyR+jN6CkvvICOB2joaf5I4l3gm9GU6Hc1og6Ls7i6U/mkkaduKaBhlAXv9k"
src="https://stackpath.bootstrapcdn.com/bootstrap/4.2.1/js/bootstrap.min.js"></script>
</body>
</html>

View File

@@ -0,0 +1,97 @@
@{
ViewBag.Title = "DiscImageChef";
}
@{
/***************************************************************************
The Disc Image Chef
----------------------------------------------------------------------------
Filename : DONATING.aspx
Author(s) : Natalia Portillo <claunia@claunia.com>
Component : DiscImageChef Server.
--[ Description ] ----------------------------------------------------------
Renders DONATING.md.
--[ License ] --------------------------------------------------------------
This library is free software; you can redistribute it and/or modify
it under the terms of the GNU Lesser General Public License as
published by the Free Software Foundation; either version 2.1 of the
License, or (at your option) any later version.
This library is distributed in the hope that it will be useful, but
WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
Lesser General Public License for more details.
You should have received a copy of the GNU Lesser General Public
License along with this library; if not, see <http://www.gnu.org/licenses/>.
----------------------------------------------------------------------------
Copyright © 2011-2018 Natalia Portillo
****************************************************************************/
}
<!DOCTYPE html>
<html>
<meta charset="UTF-8">
<head>
<link href="../../styles/dicserver.css"
rel="stylesheet"type="text/css" />
<link href="../../styles/dicserver_highcharts.css"
rel="stylesheet"type="text/css" />
<title>@ViewBag.Title</title>
<meta charset="utf-8" />
<!-- Global site tag (gtag.js) - Google Analytics -->
<script async
src="https://www.googletagmanager.com/gtag/js?id=UA-111466173-1"></script>
<script>
window.dataLayer = window.dataLayer || [];
function gtag() { dataLayer.push(arguments); }
gtag('js', new Date());
gtag('config', 'UA-111466173-1');
</script>
</head>
<body>
<p>
@Html.ActionLink("Return to main page.", "Index")<br />
DiscImageChef's template for pull requests:
</p>
<div class="container">@Html.Raw(ViewBag.Markdown)</div>
<footer class="container-fluid">
© 2011-2018
<a href="http://www.claunia.com"
target="_blank">
Claunia.com
</a><br />
Fonts are © 2015-2016
<a href="http://int10h.org"
target="_blank">
VileR
</a><br />
CSS © 2018
<a href="https://getbootstrap.com/"
target="_blank">
Bootstrap
</a> and
<a href="http://www.claunia.com"
target="_blank">
Claunia.com
</a>
</footer>
<script crossorigin="anonymous"
integrity="sha384-q8i/X+965DzO0rT7abK41JStQIAqVgRVzpbzo5smXKp4YfRvH+8abtTE1Pi6jizo"
src="https://code.jquery.com/jquery-3.3.1.slim.min.js"></script>
<script crossorigin="anonymous"
integrity="sha384-wHAiFfRlMFy6i5SRaxvfOCifBUQy1xHdJ/yoi7FRNXMRBu5WHdZYu1hA6ZOblgut"
src="https://cdnjs.cloudflare.com/ajax/libs/popper.js/1.14.6/umd/popper.min.js"></script>
<script crossorigin="anonymous"
integrity="sha384-B0UglyR+jN6CkvvICOB2joaf5I4l3gm9GU6Hc1og6Ls7i6U/mkkaduKaBhlAXv9k"
src="https://stackpath.bootstrapcdn.com/bootstrap/4.2.1/js/bootstrap.min.js"></script>
</body>
</html>

View File

@@ -0,0 +1 @@
../../CONTRIBUTING.md

View File

@@ -0,0 +1 @@
../../NEEDINFO.md