Skip to content

Updating docs - adding links- restructuring the content #69

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom
Merged
magerstam merged 7 commits into from
Apr 29, 2025
Merged

Updating docs - adding links- restructuring the content #69

magerstam merged 7 commits into from
Apr 29, 2025

Conversation

@sgolebiewski-intel
Copy link
Contributor

@sgolebiewski-intel sgolebiewski-intel commented Apr 28, 2025 •
edited
Loading

Merge Checklist

All boxes should be checked before merging the PR

  • [] The changes in the PR have been built and tested
  • [] cgmanifest file has been updated if required
  • Ready to merge

Description

Adding download links to the main README file, adding reference to the resources under toolkit\docs, and moving the Update of Edge Node Agents section to the article about building the EMT image.

@sgolebiewski-intel sgolebiewski-intel requested review from a team as code owners April 28, 2025 11:50
@sgolebiewski-intel sgolebiewski-intel force-pushed the documentation-minor-update-for-3.0-dev branch from 3c552fe to 09d435a Compare April 28, 2025 11:52
@sgolebiewski-intel sgolebiewski-intel force-pushed the documentation-minor-update-for-3.0-dev branch from 09d435a to f13ebd5 Compare April 28, 2025 11:54
@anujm1
Copy link
Contributor

anujm1 commented Apr 28, 2025

May be we should define our own template for markdownlint instead of default: https://github.com/super-linter/super-linter/blob/097074244fb53480adb40ecd7586abda3c2246bf/TEMPLATES/.markdown-lint.yml if we want to ignore the warning?

Adding tables to false in MD013 in that template would ignore the line lengths in tables.

magerstam
magerstam reviewed Apr 28, 2025
View reviewed changes
magerstam
magerstam previously approved these changes Apr 28, 2025
View reviewed changes
sgolebiewski-intel
sgolebiewski-intel commented Apr 28, 2025
View reviewed changes
@sgolebiewski-intel
Copy link
Contributor Author

sgolebiewski-intel commented Apr 28, 2025

May be we should define our own template for markdownlint instead of default: https://github.com/super-linter/super-linter/blob/097074244fb53480adb40ecd7586abda3c2246bf/TEMPLATES/.markdown-lint.yml if we want to ignore the warning?

Adding tables to false in MD013 in that template would ignore the line lengths in tables.

Sounds good to me.

@anujm1
Copy link
Contributor

anujm1 commented Apr 29, 2025

May be we should define our own template for markdownlint instead of default: https://github.com/super-linter/super-linter/blob/097074244fb53480adb40ecd7586abda3c2246bf/TEMPLATES/.markdown-lint.yml if we want to ignore the warning?
Adding tables to false in MD013 in that template would ignore the line lengths in tables.

Sounds good to me.

I've added it to this PR. Please review.

@anujm1 anujm1 requested a review from magerstam April 29, 2025 01:12
yepmunchun
yepmunchun reviewed Apr 29, 2025
View reviewed changes
magerstam
magerstam reviewed Apr 29, 2025
View reviewed changes
@magerstam
Copy link
Contributor

magerstam commented Apr 29, 2025

@anujm1 if you have bandwidth today, can you please do a quick update on the section that discusses 'add package'? It is very centralized around BMAs, while applicable there also perhaps it would be better to make the text more generic?

sgolebiewski-intel
sgolebiewski-intel commented Apr 29, 2025
View reviewed changes
pytlik-personal
pytlik-personal reviewed Apr 29, 2025
View reviewed changes
@magerstam magerstam merged commit 7008c2e into open-edge-platform:3.0-dev Apr 29, 2025
6 checks passed
sys-orch pushed a commit that referenced this pull request May 13, 2025
@sgolebiewski-intel @magerstam @anujm1
Updating docs - adding links- restructuring the content (#69)
787f6d3 
* Updating docs - adding links- restructuring the content

* Update docs/developer-guide/get-started/building-howto.md

* Add markdownlint to ignore line lengths in table

* Update docs/developer-guide/get-started/building-howto.md

* Update docs/developer-guide/get-started/building-howto.md

Co-authored-by: Sebastian Golebiewski <[email protected]>

* Apply suggestions from code review

---------

Co-authored-by: Mats Agerstam <[email protected]>
Co-authored-by: Anuj Mittal <[email protected]>
ranjan-dutta pushed a commit that referenced this pull request May 14, 2025
@sgolebiewski-intel @magerstam
@anujm1 @ranjan-dutta
Updating docs - adding links- restructuring the content (#69)
4f83b10 
* Updating docs - adding links- restructuring the content

* Update docs/developer-guide/get-started/building-howto.md

* Add markdownlint to ignore line lengths in table

* Update docs/developer-guide/get-started/building-howto.md

* Update docs/developer-guide/get-started/building-howto.md

Co-authored-by: Sebastian Golebiewski <[email protected]>

* Apply suggestions from code review

---------

Co-authored-by: Mats Agerstam <[email protected]>
Co-authored-by: Anuj Mittal <[email protected]>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@magerstam magerstam magerstam approved these changes

@yepmunchun yepmunchun yepmunchun approved these changes

+1 more reviewer

@pytlik-personal pytlik-personal pytlik-personal left review comments

Reviewers whose approvals may not affect merge requirements

Assignees

No one assigned

Labels

None yet

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

5 participants

@sgolebiewski-intel @anujm1 @magerstam @yepmunchun @pytlik-personal