Skip to content
This repository has been archived by the owner on Feb 20, 2024. It is now read-only.

fix: Redirecting Issue in the Flutter documentation #167

Merged
merged 4 commits into from
Oct 7, 2022

Conversation

PriyanshuRj
Copy link
Contributor

@PriyanshuRj PriyanshuRj commented Sep 30, 2022

- What I did
I updated the Links in the Flutter Get Started Section in the documentation at - https://docs.atsign.com/start/flutter/ .
They were earlier redirecting on the same page but now they open up on a new page.
- How I did it
I changed the links from the traditional MarkDown links to HTML anchor Tags to use the target attribute of the anchor tag to redirect to the new page.

- How to verify it
Open the Flutter portion of the Get Started section and click any of the available links to verify that they open on a new page.
image
The yellow text in the above image are all links.

- Description for the changelog
This PR includes the rectified functionality of the Links present on the flutter portion of the Get Started section. They were earlier redirection on the same page after these changes they will redirect to a new page.

@PriyanshuRj
Copy link
Contributor Author

Can i get a review on this PR please

Copy link
Member

@JeremyTubongbanua JeremyTubongbanua left a comment

Choose a reason for hiding this comment

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

hey @PriyanshuRj ! Great work!

One small problem is we don't like using html in our markdown files (because GoHugo does some stuff in the background with styling).

In case you ever have to use HTML please use our shortcodes. Shortcodes are basically React components.

So in this case, instead of using the regular html a anchor tag, use the shortcode like this:

{{< a target="_blank" href="https://atsign.com/" >}} atsign.com {{< /a >}}

The tutorial for this can be found in our Shortcodes guide

@PriyanshuRj
Copy link
Contributor Author

Okey @JeremyTubongbanua got your point will modify it.

@PriyanshuRj
Copy link
Contributor Author

Updated the conventional anchor tags to shortcode tags.

XavierChanth
XavierChanth previously approved these changes Oct 3, 2022
@XavierChanth XavierChanth changed the title Updated redirecting Issue in the Flutter documentation fix: Redirecting Issue in the Flutter documentation Oct 3, 2022
XavierChanth
XavierChanth previously approved these changes Oct 5, 2022
Copy link
Member

@XavierChanth XavierChanth left a comment

Choose a reason for hiding this comment

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

Looks good!

Copy link
Member

@JeremyTubongbanua JeremyTubongbanua left a comment

Choose a reason for hiding this comment

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

Hey @PriyanshuRj thanks for your PR

One small change and I think it's good to go

Please use the shortcode like this

{{< a href="https://code.visualstudio.com/" target="_blank">}}Visual Studio Code{{< /a >}}

as opposed to this

{{<a href="https://code.visualstudio.com/" target="_blank">}}Visual Studio Code{{</a>}}

Just to stay consistent with the rest of our documentation. Thank you!

Copy link
Member

@JeremyTubongbanua JeremyTubongbanua left a comment

Choose a reason for hiding this comment

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

Great work

@XavierChanth XavierChanth merged commit 2f6b8fd into atsign-foundation:trunk Oct 7, 2022
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants