Repository files navigation

Main CI	Latest Deployment

The following websites are maintained in this monorepo:

• https://api-extractor.com
• https://api.rushstack.io
• https://lfx.rushstack.io
• https://heft.rushstack.io/
• https://rushjs.io
• https://rushstack.io
• https://tsdoc.org

The Docusaurus websites in this monorepo support a concept called "target", which describes the environmentsites are being built for. There are 3 possible targets:

Thelocal target is intended for use when a Docusaurus development server is running locally. Thistarget will automatically be selected if you runrushx start in any of the website projects.

You can also force this target by setting the environment variableTARGET=local.

Thefork target is intended for use when you are building static Docusaurus sites for deployment,but you'll be deploying them to GitHub Pages on your fork of therushstack-websites project. This isuseful for deploying demo sites to share with others, to test on phones and tablets, etc. This targetwill automatically be selected if you run a production build (rushx build) of a website project andyou have cloned afork of therushstack-websites project.

You can also force this target by setting the environment variableTARGET=fork.

Theprod target is intended for use when you will be deploying a website project to GitHub Pagesin its live production repo. Typically this target is only used by a CI pipeline, and it is automaticallyselected if you run a production build on a clone of themicrosoft/rushstack-websites repo.

You can also force this target by setting the environment variableTARGET=prod.

To facilitate testing of multi-site changes, you can opt to build and deploy all of the website projectsat once from a fork ofrushstack-websites. To do so, first make sure you've forked the projectand cloned your fork locally, and then run:

rush installrush buildGIT_USER=<your-git-username> rush deploy-fork

The commands above will automatically build all of the supported websites withTARGET=fork, then deploythem in a group to thegh-pages branch of your forked repo. You can then access these sites via individualsite paths, for example:

https://<your-git-username>.github.io/rushstack-websites/rushstack.io/

Cross-site links between the different sites will automatically be linked up to navigate to your deployedversions of those sites.

The production Rushstack websites are deployed periodically by the maintainers using an Azure DevOps pipeline. Check the badge at the top of this README for the latest status and deployment history.

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

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

This project has adopted theMicrosoft Open Source Code of Conduct.For more information see theCode of Conduct FAQ orcontactopencode@microsoft.com with any additional questions or comments.

Microsoft and any contributors grant you a license to the Microsoft documentation and other contentin this repository under theCreative Commons Attribution 4.0 International Public License,see theLICENSE file, and grant you a license to any code in the repository under theMIT License, see theLICENSE-CODE file.

Microsoft, Windows, Microsoft Azure and/or other Microsoft products and services referenced in the documentationmay 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 athttp://go.microsoft.com/fwlink/?LinkID=254653.

Privacy information can be found athttps://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.