search

ngrok / ngrok-docs

ngrok's official documentation
https://ngrok.com/docs
MIT License
54 stars 2.08k forks source link

SEO: Soft 404s on error pages #722

Open blyonng opened 5 months ago

blyonng commented 5 months ago

If a page doesn't have sufficiently lengthy content, then it might be viewed as a soft 404.

Recommended tools for troubleshooting:

Examples of Docs pages that currently count as soft 404s include:

  1. All error pages such as https://ngrok.com/docs/errors/err_ngrok_5512

Recommended solution:

  1. Add more content to the error pages.
  2. Explain that these are not themselves error pages, but pages which explain errors. Currently Google appears to think these are errors.
nijikokun commented 2 months ago

Is there a better way to make them not be considered soft 404s that does not include adding more content. Thinking because if we do that it most likely will be duplicated content which may result in a worse or similar outcome.

blyonng commented 2 months ago

That's a good question. Realistically, I don't think it can be done without adding content. I am not an expert on this particular type of content, so I ran it through GPT for some suggestions.

The particular sections I think we're missing are the "What does this mean" and "What can you do".

We have the following content on a URL, but it's considered a soft 404. How could I improve this? ERR_NGROK_1226 Message You are disallowed from creating an ngrok account due to violation of the terms of service.

To improve the page content for the URL with the message "ERR_NGROK_1226: You are disallowed from creating an ngrok account due to violation of the terms of service," and avoid it being considered a soft 404, you can take the following steps:

Add Contextual Information:

Provide more details about the error code and what it means. Explain the possible reasons for being disallowed from creating an account. Offer Solutions:

Suggest steps that users can take if they believe the restriction is an error. Provide contact information or a link to a support form for users to appeal or inquire about the issue. Link to Related Resources:

Include links to the terms of service page. Add links to the FAQ section or support documentation that might help users understand the terms of service violations. Improve Page Structure:

Use headings, bullet points, and other formatting to make the content easy to read and scan.

Here is a revised version of the content:

ERR_NGROK_1226: Account Creation Disallowed

Message: You are disallowed from creating an ngrok account due to a violation of our terms of service.

What Does This Mean? This error occurs when an attempt to create an ngrok account is flagged for violating our terms of service. Common reasons for this restriction include:

Previous abuse or misuse of ngrok services. Violation of specific terms outlined in our Terms of Service. What Can You Do? If you believe this restriction is an error or if you have questions regarding this issue, you can take the following steps:

Review the Terms of Service:

Familiarize yourself with our Terms of Service to understand the violations that may have occurred. Contact Support:

If you think this restriction is a mistake, please reach out to our support team. Use the support contact form or email us at support@example.com with details of your issue. FAQs and Documentation:

Visit our FAQ section and support documentation for more information on common issues and solutions. Additional Resources Terms of Service FAQ Section Support Documentation Contact Support We are here to help and ensure that you have a smooth experience with ngrok. If you need further assistance, please don't hesitate to contact us.