rushstack.io-website/jekyll-archive

Getting Started

Dependencies

To run this site locally, you'll first need the following dependencies:

• Ruby
• Bundler
• Jekyll

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/.

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. For more information see the Code of Conduct FAQ or contact 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, see the LICENSE file, and grant you a license to any code in the repository under the MIT License, see the 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.