Skip to content
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.

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

docs: Amendments to AGW installation instructions #13198

Merged
merged 1 commit into from Jul 8, 2022

Conversation

voisey
Copy link
Contributor

@voisey voisey commented Jul 5, 2022

Summary

Some minor changes to the Install Access Gateway on Ubuntu (Bare Metal) page that I made when reading through the instructions.

Test Plan

  • cd magma/docs && make precommit

@voisey voisey requested review from a team and Neudrino July 5, 2022 12:59
@pull-request-size pull-request-size bot added the size/M Denotes a PR that changes 30-99 lines. label Jul 5, 2022
@github-actions
Copy link
Contributor

github-actions bot commented Jul 5, 2022

Thanks for opening a PR! 💯

A couple initial guidelines

Howto

  • Reviews. The "Reviewers" listed for this PR are the Magma maintainers who will shepherd it.
  • Checks. All required CI checks must pass before merge.
  • Merge. Once approved and passing CI checks, use the ready2merge label to indicate the maintainers can merge your PR.

More info

Please take a moment to read through the Magma project's

If this is your first Magma PR, also consider reading

@github-actions github-actions bot added the component: docs Documentation-related issue label Jul 5, 2022
Copy link
Contributor

@Neudrino Neudrino left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

There are a lot of markdown lint errors.
Could we run the markdown --fix on it?

I.e. probably the following locally (if you already have node installed):

sudo npm install --global markdownlint-cli
markdownlint --fix docs/readmes/lte/deploy_install.md

or alternatively try to do it in the respective container as indicated in the CI.

@voisey
Copy link
Contributor Author

voisey commented Jul 5, 2022

There are a lot of markdown lint errors. Could we run the markdown --fix on it?

I.e. probably the following locally (if you already have node installed):

sudo npm install --global markdownlint-cli
markdownlint --fix docs/readmes/lte/deploy_install.md

or alternatively try to do it in the respective container as indicated in the CI

I'm confused as to why the Markdown lint check in the CI is passing then. Running make precommit passes for me and nothing changes when I run make precommit_fix. Shouldn't this be equivalent to what you're suggesting I run, given that the command being executed is this one https://github.com/magma/magma/blob/master/docs/readmes/Makefile#L9?

@magma magma deleted a comment from github-actions bot Jul 8, 2022
@magma magma deleted a comment from github-actions bot Jul 8, 2022
@magma magma deleted a comment from github-actions bot Jul 8, 2022
@magma magma deleted a comment from github-actions bot Jul 8, 2022
@magma magma deleted a comment from github-actions bot Jul 8, 2022
@magma magma deleted a comment from github-actions bot Jul 8, 2022
@magma magma deleted a comment from github-actions bot Jul 8, 2022
@magma magma deleted a comment from github-actions bot Jul 8, 2022
@magma magma deleted a comment from github-actions bot Jul 8, 2022
@magma magma deleted a comment from github-actions bot Jul 8, 2022
@magma magma deleted a comment from github-actions bot Jul 8, 2022
@magma magma deleted a comment from github-actions bot Jul 8, 2022
@magma magma deleted a comment from github-actions bot Jul 8, 2022
@magma magma deleted a comment from github-actions bot Jul 8, 2022
Signed-off-by: Cameron Voisey <cameron.voisey@tngtech.com>
@voisey
Copy link
Contributor Author

voisey commented Jul 8, 2022

Hi @Neudrino, now that the linting has been fixed, could you please take another look at this?

@voisey voisey enabled auto-merge (squash) July 8, 2022 11:35
@voisey voisey merged commit c489f2d into magma:master Jul 8, 2022
emakeev pushed a commit to emakeev/magma that referenced this pull request Aug 5, 2022
Signed-off-by: Cameron Voisey <cameron.voisey@tngtech.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
component: docs Documentation-related issue size/M Denotes a PR that changes 30-99 lines.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

2 participants