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

Minor updates to Configuation and Initial Login includes #1805

Merged
merged 5 commits into from
Aug 20, 2024

Conversation

qahmed1998
Copy link
Contributor

@qahmed1998 qahmed1998 commented Aug 12, 2024

This PR just cleanups up some minor issues in "Installing on Google Compute Engine topic".

@qahmed1998
Copy link
Contributor Author

@miq-bot assign @Fryguy

@agrare
Copy link
Member

agrare commented Aug 12, 2024

Hey @qahmed1998 could you add a more descriptive title and description about what this change is doing?

@qahmed1998
Copy link
Contributor Author

@miq-bot add_labels radjabov/yes?

@@ -1,8 +1,7 @@
Change your password to ensure more private and secure access to
{{ site.data.product.title_short }}.

1. Browse to the URL for the login screen. (<https://xx.xx.xx.xx> on
the virtual machine instance)
1. Browse to the URL for the login screen.
Copy link
Contributor Author

Choose a reason for hiding this comment

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

@Fryguy how can we improve this line?

Copy link
Member

Choose a reason for hiding this comment

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

The parenthesis shows an example, so maybe adding an e.g.? I'm not sure what was wrong with it originally.

Copy link
Member

@agrare agrare Aug 14, 2024

Choose a reason for hiding this comment

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

Yeah I think the original was okay, maybe something to say "get the ipaddress or hostname from the VM"

Copy link
Contributor Author

Choose a reason for hiding this comment

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

I meant like in terms of navigation, how does a user get the URL?

Copy link
Member

Choose a reason for hiding this comment

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

It is going to be different on every platform (vmware, amazon, google, etc...) but all of them will show you the IP address and/or dns name of the VM in some way.

Copy link
Contributor Author

@qahmed1998 qahmed1998 Aug 19, 2024

Choose a reason for hiding this comment

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

Hmm for example this doc is for GCP, I am still not sure how exactly user will get the URL for the login screen. We should mention it in terms of how to get that URL.

Copy link
Member

Choose a reason for hiding this comment

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

This doc isn't for GCP, it is included into all of the "installing_on_*" docs,

$ grep -r initial-login-changepw
installing_on_scvmm/index.md:{% include initial-login-changepw.md %}
installing_on_vmware_vsphere/index.md:{% include initial-login-changepw.md %}
installing_on_microsoft_azure/index.md:{% include initial-login-changepw.md %}
installing_on_google_compute_engine/index.md:{% include initial-login-changepw.md %}
installing_on_red_hat_virtualization/index.md:{% include initial-login-changepw.md %}
grep: .git/index: binary file matches
installing_on_red_hat_enterprise_linux_openstack_platform/index.md:{% include initial-login-changepw.md %}

Which was the point of my comment 👇 #1805 (comment)

Copy link
Member

Choose a reason for hiding this comment

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

IMO I think it is reasonable to assume that a user will know how to get the IP address of the VM that they just deployed on whatever platform they're using.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

ok thanks Adam.

@qahmed1998 qahmed1998 changed the title Minor updates Minor updates to Installing on Google Compute Engine topic Aug 12, 2024
@Fryguy Fryguy assigned agrare and unassigned Fryguy Aug 13, 2024
@agrare
Copy link
Member

agrare commented Aug 14, 2024

@qahmed1998 FYI it looks like these changes are all to includes which are in multiple topics not just google compute engine

@qahmed1998
Copy link
Contributor Author

Hi @agrare @Fryguy Please approve/merge if all looks good.

@miq-bot
Copy link
Member

miq-bot commented Aug 19, 2024

Checked commits qahmed1998/manageiq-documentation@570f458~...41a0b02 with ruby 3.1.5, rubocop 1.56.3, haml-lint 0.51.0, and yamllint
0 files checked, 0 offenses detected
Everything looks fine. 🍪

@agrare agrare merged commit c64feef into ManageIQ:master Aug 20, 2024
2 checks passed
@agrare agrare changed the title Minor updates to Installing on Google Compute Engine topic Minor updates to Configuation and Initial Login includes Aug 20, 2024
github-actions bot pushed a commit to ManageIQ/manageiq.github.io that referenced this pull request Aug 20, 2024
@Fryguy
Copy link
Member

Fryguy commented Aug 22, 2024

Backported to radjabov in commit 4eb94c9.

commit 4eb94c9964183368a32c572242a9570d7c8a54b8
Author: Adam Grare <adam@grare.com>
Date:   Tue Aug 20 10:35:48 2024 -0400

    Merge pull request #1805 from qahmed1998/QA-minor-changes-gcp
    
    Minor updates to Installing on Google Compute Engine topic
    
    (cherry picked from commit c64feef8832df1d360790ed455e17d01d3b28145)

Fryguy pushed a commit that referenced this pull request Aug 22, 2024
Minor updates to Installing on Google Compute Engine topic

(cherry picked from commit c64feef)
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants