Merge pull request #61 from microsoft/octogonz/docusaurus-migration

Archive Jekyll project and update README.md

README.md

@@ -1,37 +1,16 @@
-# Getting Started
+# tsdoc.org deployment repo
 
-## Dependencies
+This repository hosts GitHub Pages deployments for the https://tsdoc.org website.
 
-To run this site locally, you'll first need the following dependencies:
+**Website source files:** https://github.com/microsoft/rushstack-websites/tree/main/websites/tsdoc.org
 
-* [Ruby](https://www.ruby-lang.org/en/)
-* [Bundler](https://bundler.io/)
-* [Jekyll](https://jekyllrb.com/)
+**Deploy branch:** https://github.com/microsoft/tsdoc.org-website/tree/gh-pages
 
-## Run Locally
-
-Once the above dependencies are installed on your local machine, run the following commands to install the latest dependencies
-and run the solution locally:
-
-1. Install the site's gem dependencies with `bundle install` at the root of the project.
-2. Start the local web server with `bundle exec jekyll serve` or for incremental builds run `bundle exec jekyll serve --incremental`.
-3. Once the site has been generated you'll be able to navigate to it at [http://127.0.0.1:4000/](http://127.0.0.1:4000/).
-
-## Regenerating the search index
-
-1. Log in to the https://www.algolia.com/ dashboard using the "rushbot" GitHub alias
-2. Confirm that the Search-Only API Key and Application ID match the definitions in _config.yml
-3. Run this command:
-
-```
-set ALGOLIA_API_KEY=(your_admin_api_key)
-bundle exec jekyll build
-bundle exec jekyll algolia
-```
+If you have questions or suggestions regarding the `tsdoc.org` website, please create your issue in the upstream [rushstack-websites](https://github.com/microsoft/rushstack-websites/issues) monorepo.
 
 # Contributing
 
-This project welcomes contributions and suggestions.  Most contributions require you to agree to a
+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.microsoft.com.
 

SECURITY.md

@@ -0,0 +1,41 @@
+<!-- BEGIN MICROSOFT SECURITY.MD V0.0.7 BLOCK -->
+
+## Security
+
+Microsoft takes the security of our software products and services seriously, which includes all source code repositories managed through our GitHub organizations, which include [Microsoft](https://github.com/Microsoft), [Azure](https://github.com/Azure), [DotNet](https://github.com/dotnet), [AspNet](https://github.com/aspnet), [Xamarin](https://github.com/xamarin), and [our GitHub organizations](https://opensource.microsoft.com/).
+
+If you believe you have found a security vulnerability in any Microsoft-owned repository that meets [Microsoft's definition of a security vulnerability](https://aka.ms/opensource/security/definition), please report it to us as described below.
+
+## Reporting Security Issues
+
+**Please do not report security vulnerabilities through public GitHub issues.**
+
+Instead, please report them to the Microsoft Security Response Center (MSRC) at [https://msrc.microsoft.com/create-report](https://aka.ms/opensource/security/create-report).
+
+If you prefer to submit without logging in, send email to [secure@microsoft.com](mailto:secure@microsoft.com).  If possible, encrypt your message with our PGP key; please download it from the [Microsoft Security Response Center PGP Key page](https://aka.ms/opensource/security/pgpkey).
+
+You should receive a response within 24 hours. If for some reason you do not, please follow up via email to ensure we received your original message. Additional information can be found at [microsoft.com/msrc](https://aka.ms/opensource/security/msrc). 
+
+Please include the requested information listed below (as much as you can provide) to help us better understand the nature and scope of the possible issue:
+
+  * Type of issue (e.g. buffer overflow, SQL injection, cross-site scripting, etc.)
+  * Full paths of source file(s) related to the manifestation of the issue
+  * The location of the affected source code (tag/branch/commit or direct URL)
+  * Any special configuration required to reproduce the issue
+  * Step-by-step instructions to reproduce the issue
+  * Proof-of-concept or exploit code (if possible)
+  * Impact of the issue, including how an attacker might exploit the issue
+
+This information will help us triage your report more quickly.
+
+If you are reporting for a bug bounty, more complete reports can contribute to a higher bounty award. Please visit our [Microsoft Bug Bounty Program](https://aka.ms/opensource/security/bounty) page for more details about our active programs.
+
+## Preferred Languages
+
+We prefer all communications to be in English.
+
+## Policy
+
+Microsoft follows the principle of [Coordinated Vulnerability Disclosure](https://aka.ms/opensource/security/cvd).
+
+<!-- END MICROSOFT SECURITY.MD BLOCK -->

jekyll-archive/README.md

@@ -0,0 +1,61 @@
+# Getting Started
+
+## Dependencies
+
+To run this site locally, you'll first need the following dependencies:
+
+* [Ruby](https://www.ruby-lang.org/en/)
+* [Bundler](https://bundler.io/)
+* [Jekyll](https://jekyllrb.com/)
+
+## Run Locally
+
+Once the above dependencies are installed on your local machine, run the following commands to install the latest dependencies
+and run the solution locally:
+
+1. Install the site's gem dependencies with `bundle install` at the root of the project.
+2. Start the local web server with `bundle exec jekyll serve` or for incremental builds run `bundle exec jekyll serve --incremental`.
+3. Once the site has been generated you'll be able to navigate to it at [http://127.0.0.1:4000/](http://127.0.0.1:4000/).
+
+## Regenerating the search index
+
+1. Log in to the https://www.algolia.com/ dashboard using the "rushbot" GitHub alias
+2. Confirm that the Search-Only API Key and Application ID match the definitions in _config.yml
+3. Run this command:
+
+```
+set ALGOLIA_API_KEY=(your_admin_api_key)
+bundle exec jekyll build
+bundle exec jekyll algolia
+```
+
+# 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.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., label, 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](https://opensource.microsoft.com/codeofconduct/).
+For more information see the [Code of Conduct FAQ](https://opensource.microsoft.com/codeofconduct/faq/) or
+contact [opencode@microsoft.com](mailto:opencode@microsoft.com) with any additional questions or comments.
+
+# Legal Notices
+
+Microsoft and any contributors grant you a license to the Microsoft documentation and other content
+in this repository under the [Creative Commons Attribution 4.0 International Public License](https://creativecommons.org/licenses/by/4.0/legalcode),
+see the [LICENSE](LICENSE) file, and grant you a license to any code in the repository under the [MIT License](https://opensource.org/licenses/MIT), see the
+[LICENSE-CODE](LICENSE-CODE) file.
+
+Microsoft, Windows, Microsoft Azure and/or other Microsoft products and services referenced in the documentation
+may be either trademarks or registered trademarks of Microsoft in the United States and/or other countries.
+The licenses for this project do not grant you rights to use any Microsoft names, logos, or trademarks.
+Microsoft's general trademark guidelines can be found at http://go.microsoft.com/fwlink/?LinkID=254653.
+
+Privacy information can be found at https://privacy.microsoft.com/en-us/
+
+Microsoft and any contributors reserve all others rights, whether under their respective copyrights, patents,
+or trademarks, whether by implication, estoppel or otherwise.