-
Notifications
You must be signed in to change notification settings - Fork 35
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
Feature/api tour #1602
Feature/api tour #1602
Conversation
@jykae or @marla-singer: please review. Ping @bajiat |
@brylie Reviewing |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Basic introduction on API page looks nice 👍 Change some remarks and I will merge it. What about the attributes for links, these is at your discretion
{{_ "aboutApinf_homepage" }} | ||
</dt> | ||
<dd> | ||
<a href="https://apinf.org"> |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Just recommendation for user usability: Tag should have an attribute target="_blank" for the outside links. Then users won't leave the site completely
<a href="#api-metadata" data-toggle="tab"> | ||
<i class="fa fa-book"></i> | ||
{{_ "viewApiNavigationMenu_metadata" }} | ||
</a> | ||
</li> | ||
<li> | ||
<li id="api-feedback-tab"> |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Add comment in this line too
@@ -11,7 +11,7 @@ | |||
background-color: #fafafa; | |||
border-bottom: 1px solid #eee; | |||
|
|||
.api-name { | |||
.api-header { |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
@@ -0,0 +1,496 @@ | |||
.introjs-overlay { | |||
position: absolute; |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Try importing the introjs CSS directly from the NPM package:
"apiIntro_steps_feedback_intro": "Users of your API can give feedback, including reporting errors or requesting new features.", | ||
"apiIntro_steps_metadata_intro": "Provide organizational, contact and service related information about your API.", | ||
"apiIntro_steps_proxy_intro": "Use this tab to attach your API to a proxy, allowing you to use various API management related features (e.g. analytics, API keys, etc.).", | ||
"apiIntro_steps_settings_intro": "Edit API settings from this tab. You can also delete also API here.", |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Edit the second sentence: using the word 'also' twice
@marla-singer I made the suggested changes. Please review. |
@brylie I go ahead and correct query selector by myself. All good. Merging |
Closes #1434
Closes #1445
Closes #1613
Changes