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

please somehow render any links for the dependencies #27

Open
joshlong opened this issue Jan 19, 2018 · 4 comments
Open

please somehow render any links for the dependencies #27

joshlong opened this issue Jan 19, 2018 · 4 comments
Assignees

Comments

@joshlong
Copy link

the dependencies (sometimes) have things like links to documentation or guides.

Maybe it could be rendered in the 2 line textbox for the suggested dependency?

@Eskibear
Copy link
Member

Eskibear commented Jan 22, 2018

[UPDATED]
I find the links, e.g.

{
    "id": "security",
    "name": "Security",
    "description": "Secure your application via spring-security",
    "_links": {
        "guide": [
            {
                "href": "https://spring.io/guides/gs/securing-web/",
                "title": "Securing a Web Application"
            },
            {
                "href": "https://spring.io/guides/tutorials/spring-boot-oauth2/",
                "title": "Spring Boot and OAuth2"
            },
            {
                "href": "https://spring.io/guides/gs/authenticating-ldap/",
                "title": "Authenticating a User with LDAP"
            }
        ],
        "reference": {
            "href": "http://docs.spring.io/spring-boot/docs/{bootVersion}/reference/htmlsingle/#boot-features-security",
            "templated": true
        }
    }
},

Are they rendered in WebUI now?

And one thing to mention, even if we have rendered a link in the textbox, it's regarded as plain text. We have to seek for other ways to navigate users to the guides.

@snicoll
Copy link

snicoll commented Jan 22, 2018

Please check the documentation.

Are they rendered in WebUI now?

See spring-io/initializr#353

if we have rendered a link in the textbox, it's regarded as plain text.

FWIW I don't see the value of rendering the link the proposed format. It works very well in the IDE where you have a full screen to browse through the available dependencies and figure out what they do by clicking links on them.

@brunovieira97
Copy link
Contributor

Is this issue still valid?

We currently have a button for each dependency that opens _links.reference.href, and I believe that within our design simplicity intentions, it achieves what's asked here.

@Eskibear
Copy link
Member

yes, the reference link can be opened as below:
image

Actually, there are already buttons for reference, sample, home. This issue should be fine to close.

if (links?.home?.href) {
const homeButton = {
iconPath: new ThemeIcon("home"),
tooltip: links.home.title ?? "Homepage",
...links.home
};
buttons.push(homeButton);
}
if (links?.sample?.href) {
const sampleButton = {
iconPath: new ThemeIcon("repo"),
tooltip: links.sample.title ?? "Sample",
...links.sample
};
buttons.push(sampleButton);
}
if (links?.reference?.href) {
const referenceButton = {
iconPath: new ThemeIcon("link-external"),
tooltip: links.reference.title ?? "Reference",
...links.reference
};
buttons.push(referenceButton);
}
return buttons;

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

6 participants