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

Fixed link to docs #3670

Closed
wants to merge 8 commits into from
Closed

Fixed link to docs #3670

wants to merge 8 commits into from

Conversation

mnosov622
Copy link
Contributor

@mnosov622 mnosov622 commented Oct 3, 2022

Hello!

Please review the bug fix.

Issue This PR Addresses

  1. Automatically close the issue when this PR is merged
    USAGE: Fixes Documentation link points to Docusaurus #3445

Type of Change

Bug

Description

Fixed the link to the Telescope documentation, the previous link was going to docusaurus documentaton

Steps to test the PR

Checklist

  • Quality: This PR builds and passes our npm test and works locally

  • Tests: This PR includes thorough tests or an explanation of why it does not

  • Screenshots:
    screenshot

  • Documentation: This PR includes updated/added documentation to user exposed functionality or configuration variables are added/changed or an explanation of why it does not(if applicable)

@gitpod-io
Copy link

gitpod-io bot commented Oct 3, 2022

@@ -120,7 +120,7 @@ const config = async () => {
items: [
{
label: 'Documentation',
href: 'https://docusaurus.io/docs/',
href: 'https://telescope.cdot.systems/docs/overview/',
Copy link
Contributor

@Kevan-Y Kevan-Y Oct 3, 2022

Choose a reason for hiding this comment

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

Thank you for your contribution. Always good to have new contributor.
We have 2 environments for this
One staging: https://dev.telescope.cdot.systems/docs/overview/
One production: https://telescope.cdot.systems/docs/overview/

I don't think it's a good idea to redirect always to production.

I believe you can do relatives path see

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Hi @Kevan-Y ,

Thank you for your feedback, I changed the link, hopefully it's okay :)

Copy link
Contributor

Choose a reason for hiding this comment

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

@mnosov622 it looks like you've switched to using an absolute URL to staging now, which also won't work. What @Kevan-Y is saying is that we need this to work no matter where we host this site. The link needs to take into account the fact that we host this same site on different URLs.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Hi @humphd ,

Oh, yes, I'm sorry, i get it. Please let me know if everything is fine now :)

src/web/docusaurus/docusaurus.config.js Outdated Show resolved Hide resolved
Copy link
Contributor

@cindyorangis cindyorangis left a comment

Choose a reason for hiding this comment

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

Thanks a lot for doing this. Please squash and rebase your commits then we can have it merged into the master branch :)

https://telescope.cdot.systems/docs/contributing/git-workflow

@mnosov622 mnosov622 closed this by deleting the head repository Oct 4, 2022
@mnosov622
Copy link
Contributor Author

Hello!

I'm sorry, I will make another pull request, hopefully it's okay :)

@mnosov622
Copy link
Contributor Author

I created another pull request, thank you :) #3674

@Kevan-Y
Copy link
Contributor

Kevan-Y commented Oct 4, 2022

Thanks a lot for doing this. Please squash and rebase your commits then we can have it merged into the master branch :)

https://telescope.cdot.systems/docs/contributing/git-workflow

GitHub now has squash and merge button (I use too much of this button😅), but we just need to make sure the branch has the latest stuff
image

@mnosov622
Copy link
Contributor Author

Thank you, Kevan ! I didn't know about that :)

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
area: docusaurus Anything related to Docusaurus hacktoberfest-accepted
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Documentation link points to Docusaurus
5 participants