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

ServiceNow Service Graph Connector for Terraform - 1.0.0 GA documentation #369

Closed

Conversation

jastr945
Copy link
Contributor

@jastr945 jastr945 commented Jun 8, 2023

To be merged when the Service Graph Connector for Terraform goes GA on July 26th.

Website preview: https://terraform-docs-common-qxhx483tf-hashicorp.vercel.app/terraform/cloud-docs/integrations/service-now/service-graph

What

A new integration between TFC/E and ServiceNow - the Service Graph Connector for Terraform - goes live on July 26th. This PR adds a new section to Terraform Cloud > Integrations > ServiceNow Integrations > Service Graph Connector for Terraform. The new section contains 4 child pages documenting the setup and various parts of the new application.

The menu hierarchy has changed. The previous "ServiceNow Integration" section contains documentation about our existing app - the Service Catalog for Terraform. Now that we have the 2nd app, both of them will be located under Terraform Cloud > Integrations > ServiceNow Integrations. PR handling redirects: hashicorp/terraform-website#2495

Screenshot 2023-06-09 at 9 31 56 AM

This PR should be merged on the go-live date - July 26th.

A few notes:

  • there are at least 2 "TODO" elements left in this PR that need to be filled once the app is published in the ServiceNow Store (screenshots and links);
  • the "Resource Coverage" page contains a lot of tables. I really don't like how it looks and would appreciate any advice on making it more user-friendly.
  • Not sure why images don't show up in the deployed preview.

There is a related PR to update the previously published tutorial for the Service Graph Connector for Terraform. A few GA-related updates have been made to the tutorial. We also plan to merge them on July 26th: https://github.com/hashicorp/tutorials/pull/1381

Why

Technical documentation of the brand new application needs to be provided to end users.


Merge Checklist

If items do not apply to your changes, add (N/A) and mark them as complete.

Pull Request

  • One or more labels describe the type of change (e.g. clarification) and associated product (e.g. tfc).
  • Description links to related pull requests or issues, if any.

Content

  • Redirects have been added for moved, renamed, or deleted pages. This requires a separate PR in the terraform-website repository redirects.next.js file.
  • N/A API documentation and the API Changelog have been updated.
  • Links to related content where appropriate (e.g., API endpoints, permissions, etc.).
  • Pages with related content are updated and link to this content when appropriate.
  • Sidebar navigation files have been updated for added, deleted, reordered, or renamed pages.
  • New pages have metadata (page name and description) at the top.
  • New images are 2048 px wide. They have HashiCorp standard annotation color (#F92672) and format (rectangle with rounded corners), blurred sensitive details (e.g. credentials, usernames, user icons), and descriptive alt text in the markdown for accessibility.
  • N/A (no code blocks). New code blocks have the correct syntax and line breaks to eliminate horizontal scroll bars.
  • UI elements (button names, page names, etc.) are bolded.
  • The Vercel website preview successfully deployed.

Reviews

  • I or someone else reviewed the content for technical accuracy.
  • I or someone else reviewed the content for typos, punctuation, spelling, and grammar.

@jastr945 jastr945 added documentation Improvements or additions to documentation do not merge labels Jun 8, 2023
@vercel
Copy link

vercel bot commented Jun 8, 2023

@jastr945 is attempting to deploy a commit to the HashiCorp Team on Vercel.

A member of the Team first needs to authorize it.

@vercel
Copy link

vercel bot commented Jun 8, 2023

The latest updates on your projects. Learn more about Vercel for Git ↗︎

Name Status Preview Comments Updated (UTC)
terraform-docs-common ✅ Ready (Inspect) Visit Preview 💬 Add feedback Jun 13, 2023 3:41pm

@jastr945 jastr945 changed the title Servicenow service graph basic ServiceNow Service Graph Connector for Terraform - 1.0.0 GA documentation Jun 9, 2023
@jastr945
Copy link
Contributor Author

Closing in favor of #375, since it was created from a forked branch, which causes issues with image loading.

@jastr945 jastr945 closed this Jun 13, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
do not merge documentation Improvements or additions to documentation HCP Terraform ServiceNow
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

2 participants