66 lines
2.9 KiB
Markdown
66 lines
2.9 KiB
Markdown
# alguidelines.dev Site Source Repo
|
|
|
|
This is the source for the [alguidelines.dev](https://alguidelines.dev)
|
|
website.
|
|
# Business Central Design Patterns & Best Practices
|
|
|
|
This site is meant to house some of the community's knowledge about Microsoft Dynamics 365 Business Central AL Development best practices, particularly around hosting Design Patterns.
|
|
|
|
Please see the [ALGuidelines.dev](https://alguidelines.dev/) site for the full information about this project.
|
|
|
|
## Repo organization
|
|
|
|
This is a [hugo](https://gohugo.io) statically-generated site, hosted
|
|
on [GitHub Pages](https://https://pages.github.com). The site is automatically built by
|
|
GitHub Actions (see regen-gh-pages.yml).
|
|
|
|
All site content is stored in the `content` directory in markdown format.
|
|
|
|
```text
|
|
content/en
|
|
├── _index.html # Landing page
|
|
├── author # Info about blog authors
|
|
├── blog # Blog posts
|
|
├── docs # Documentation pages
|
|
└── search.md
|
|
```
|
|
## 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.opensource.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., status check, 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.
|
|
|
|
### Setup
|
|
|
|
**Run Hugo server**
|
|
```
|
|
$ hugo server
|
|
Web Server is available at http://localhost:1313/ (bind address 127.0.0.1)
|
|
Press Ctrl+C to stop
|
|
```
|
|
You can visit [localhost:1313](http://localhost:1313/) in browser to preview website.
|
|
|
|
### Making changes
|
|
|
|
1. Create a new branch
|
|
2. Make your changes
|
|
3. Verify your changes locally with Hugo server
|
|
4. Commit and push your changes to the branch
|
|
5. Raise a PR to main branch
|
|
6. Once PR is merged, your changes would be live on the site
|
|
|
|
## Trademarks
|
|
|
|
This project may contain trademarks or logos for projects, products, or services. Authorized use of Microsoft
|
|
trademarks or logos is subject to and must follow
|
|
[Microsoft's Trademark & Brand Guidelines](https://www.microsoft.com/en-us/legal/intellectualproperty/trademarks/usage/general).
|
|
Use of Microsoft trademarks or logos in modified versions of this project must not cause confusion or imply Microsoft sponsorship.
|
|
Any use of third-party trademarks or logos are subject to those third-party's policies.
|