okta/okta-developer-docs

okta-developer-docs

okta-developer-docs's Issues

Broken image link

In the page: https://developer.okta.com/standards/SAML/setting_up_a_saml_application_in_okta/

There is a broken image in the line:

Click on the blue "Admin" button ![Admin"](/img/okta-admin-ui-button-admin.png "Admin"")

Padding/Alignment issue on page

I notice that the formatting on this pages is messed up -

• https://developer.okta.com/code/dotnet/sample_application/
• https://developer.okta.com/code/java/spring_security_saml/

Broken table in Apps API doc

The table in this sub-section is broken:
https://developer.okta.com/docs/api/resources/apps/#attribute-statements-object

Multiple sign-up pages?

What is the difference between these two developer sign-up pages?

• https://developer.okta.com/signup/
• https://www.okta.com/developer-sign-up/

Is the latter intended for more of a shared resource?

Update sign-in widget from 2.7.0. to 2.19.0 on developer.okta.com/live-widget

The widget hosted on https://developer.okta.com/live-widget/ is currently using version 2.7.0 which does not support new functionalities, nor new languages, such as norwegian (language: nb).

Docs page "flashes" with unloaded css

When the doc page loads, it has weird formatting, but then corrects itself after about a second. The experience is a "blink" on the page.

Hardcopy Printouts

I'm noticing that when I print out a page from our site, text is cut off at the the top of each hardcopy page, i.e., a few lines of text are just missing from the hardcopy at the top of each pages. I think that what's happening is that the text is getting hidden behind the menu bar, which is repeated in the printout at the top of each page. Don't know if this has to do with my particular browser or printer, but the issue I think we should look into is whether pages print out okay, and if not can we tweak to improve that. Does the CSS stylesheet have a "@media print { .... }" section? Maybe it could set the menu bar and other navigation elements to hidden?

Search autocomplete is broken

Pages not hosted by VuePress have autocomplete behavior in the search box:

GTM is not firing properly

I see it in code but I believe it's not firing at all

Allow the use of site variables

During migration, we have to remove all {{site.versions for string replacement.

We should allow for swapping these dynamically

Pages that were affected

• packages/@okta/vuepress-site/code/angular/okta_angular_sign-in_widget/index.md
• packages/@okta/vuepress-site/code/javascript/okta_auth_sdk/index.md
• packages/@okta/vuepress-site/code/javascript/okta_sign-in_widget/index.md
• packages/@okta/vuepress-site/quickstart-fragments/java/generic-implicit/index.md
• packages/@okta/vuepress-site/quickstart-fragments/java/spring-auth-code/index.md
• packages/@okta/vuepress-site/quickstart-fragments/java/spring-implicit/index.md
• packages/@okta/vuepress-site/quickstart-fragments/widget/default-example/index.md
• packages/@okta/vuepress-theme-default/global-components/ApiOperation.vue

Support links are incorrect

The links under the Support dropdown are duplicated from the Docs dropdown:

This only occurs on VuePress pages, not on / or /blog.

404s

I'm not sure if these are related to the migration but here are the 404s from last week

Page	Pageviews
developer.okta.com/3rd_party_notices/iOS_Verify.html	555
developer.okta.com/3rd_party_notices/Android_Verify.html	297
developer.okta.com/3rd_party_notices/Android_Mobile.html	147
developer.okta.com/docs/getting_started/okta_expression_lang.html	96
developer.okta.com/docs/api/resources/users.html	53
developer.okta.com/docs/api/resources/authn.html	52
developer.okta.com/docs/api/resources/oidc.html	45
developer.okta.com/standards/OAuth/	41
developer.okta.com/docs/api/resources/oauth2.html	38
developer.okta.com/docs/api/postman/example.oktapreview.com.environment	37
developer.okta.com/docs/guides/saml_guidance	32
developer.okta.com/standards/OIDC/	26
developer.okta.com/docs/api/getting_started/design_principles.html	24
developer.okta.com/standards/SAML/index	21
developer.okta.com/assets/favicon/index.html	20
developer.okta.com/docs/api/resources/sessions.html	15
developer.okta.com/docs/guides/okta_mobile_connect	15
developer.okta.com/reference/okta_expression_language/index	14
developer.okta.com/docs/api/getting_started/design_principles/getting_a_token	13
developer.okta.com/docs/api/getting_started/enabling_cors.html	10
developer.okta.com/docs/api/getting_started/okta_expression_lang.html	10

Table formatting in SysLog API doc

Majority of tables are slightly broken at the following URL:
https://developer.okta.com/docs/api/resources/system_log/#securitycontext-object

Showing some minor formatting issues such as

Mid-way through the page, Event Correlation Example breaks table of contents into page
(https://developer.okta.com/docs/api/resources/system_log/#event-correlation-example)

This might be solved by adjusting <td> styling with word-wrap: break-word; , etc.
Additionally, headers are wrapped with <code></code> element, deviates style from other tables on page.

yarn test errors

Many errors, including:

50) quickstart page content spec should load the .NET/ASP 4 content when I click .NET/ASP 4
  ✓ sidebar navigation spec has links in side navigation: 106ms
    sidebar navigation spec contains Authentication Reference sub-links on reference side navigation: Error during Promise resolution:  No element found using locator: By(link text, Sign in Your Users)
[...]
    sidebar navigation spec contains API Reference sub-links on reference side navigation: Error during Promise resolution:  No element found using locator: By(link text, Manage Okta Resources)

1) page layout and browser size spec
       shows the main navigation with desktop browser sizes:

      expects Desktop Nav to be displayed
      + expected - actual

      -false
      +true

      at util.itHelper (tests/selenium/spec/page-layout-browser-size-spec.js:21:95)
      at <anonymous>
      at process._tickCallback (internal/process/next_tick.js:188:7)

  2) quickstarts page default selections spec
       selects okta-sign-in-page + nodejs + express if nothing is specified:

      AssertionError: expected [ '', '', '' ] to be a superset of [ Array(3) ]
      + expected - actual

       [
      -  ""
      -  ""
      -  ""
      +  "Okta Sign-In Page"
      +  "Node JS"
      +  "Express.js"
       ]

and so on.

If you navigate directly to a documentation link, the link address changes to something else in the browser address bar.

Steps to reproduce:

Browse to: https://developer.okta.com/docs/api/resources/apps/#add-bookmark-application

After the page fully resolves, you'll notice that the url changes in the browser address bar to:

https://developer.okta.com/docs/api/resources/apps/#add-application

Anchor links not working on https://developer.okta.com/docs/change-log/

It looks as though anchor links on https://developer.okta.com/docs/change-log/ don't add the anchor id to the url when clicking:

However right, right clicking produces the correct URL:

But, after scrolling the page and refreshing, the anchor is not respected. Instead the last scroll position is used for positioning.

Odd back button behavior

One report says:

1. visit https://developer.okta.com/docs/api/resources/oauth-clients/
2. without scrolling, click Client Application Operations in the right nav
3. click back. this triggers a fade-in, the URL doesn't change, and you end up still at Client Application Operations

When I attempted to recreate, the back button wasn't even enabled - my browser history was empty.

Behavior may be different between Chrome/Safari/FF

Numbering is not displayed on page

In the following page, steps should be indented with numbers. But they're not displayed. (Set Up Your Environment section)

Looking at the source markdown, though shows that the numbers are present. Not sure what the issue is but the page is not rendered correctly.

Ensure header levels are consistent

This PR fixed header levels on a specific page: #256

We need to audit other pages to make sure we don't have "Request Parameters" and "Response Parameters" headings showing up in page TOCs. They should be h5s.

{yourOktaDomain} swap not consistant

It appears that the update to fix #78 made it so not every instance of {yourOktaDomain} was swapped out.

Customize preload/prefetch option

The prefetch option is causing a lot of items in the head.

we should address this.

https://vuepress.vuejs.org/config/#shouldprefetch

The slash after {yourOktaDomain} is cut in articles

When converting {yourOktaDomain} to a customer's actual org, the slash after it is not kept and, as such, the URL is incorrectly displayed. This seems to be a conversion issue as the documentation has the URL correctly configured.

Example
https://developer.okta.com/authentication-guide/implementing-authentication/auth-code/#_1-setting-up-your-application

URL displayed is

https://dragos.okta.comoauth2/default/v1/authorize?client_id=0oabucvy
c38HLL1ef0h7&response_type=code&scope=openid&redirect_uri=http%3A%2F%2Flocal
host%3A8080&state=state-296bc9a0-a2a2-4a57-be1a-d0e2fd9bb601

instead of

https://dragos.okta.com/oauth2/default/v1/authorize?client_id=0oabucvy
c38HLL1ef0h7&response_type=code&scope=openid&redirect_uri=http%3A%2F%2Flocal
host%3A8080&state=state-296bc9a0-a2a2-4a57-be1a-d0e2fd9bb601

Broken "Okta Expression" link

Reproduction:

1. Click this link https://developer.okta.com/docs/api/resources/apps/#profile-object
2. Click the "Okta Expression" link
3. Observe broken page (screenshot below)
   

Add a markdown linter to travis to check common errors

Lots of table errors have popped up along with some others items here and there. We should look at adding some form of a markdown linter to our tool set for travis ci

Go to console button has extra padding

I believe this is a nim regression:

Reformat all tables

After migration, there are a bunch of poorly formatted tables in code. Most of them still render, but someone should go through and re-format all tables in the markdown files to make them look standardized.

To help with this, you can use the intelliJ plugin https://plugins.jetbrains.com/plugin/7550-pipe-table-formatter

Lint curl examples

Gabriel created a PR on the old repo that lints curl syntax for correctness: https://github.com/okta/okta.github.io/pull/2593/files

We should consider this to keep our curl examples accurate.

Links to guides and guide sections

A GuideLink component would be a big help for guide authors. There are a few scenarios to support:

1. Linking to a specific section of the current guide

For example:

Make sure you have [completed the prerequisites](/guides/sign-into-spa/-/before-you-begin).

The current stack selection should be preserved. The link text should be the title of the guide section, unless specified by the author.

2. Linking to a specific section of a guide from a different guide, or from another area of documentation

See [Use the Access Token](/guides/sign-into-spa/-/use-the-access-token) in the Sign Users into Your Single-Page Applications guide.

Because different guides have different stacks, the current stack selection does not need to be preserved. The link text should be the title of the guide section, unless specified by the author.

3. Linking to the beginning of a guide, either from another guide or from another part of documentation

Read the [Sign Users into Single-Page Applications](/guides/sign-into-spa) guide.

The current stack selection does not need to be preserved. The link text should be the title of the guide, unless specified by the author.

http://developer.okta.com/docs/sdk/opp/javadoc/index.html

The link to javadoc is broken

Add Next Steps Section Back to SPA

Removing this section from the SPA guide, since it has no other guides to link to. This is the reminder to put it back in as the others go live.

Guides don’t work on mobile

The guides don’t work on my iPhone X. I can’t scroll right to see the content.

Postman collections can't be accessed from developer.okta.com

Description:
Postman collections under /packages/@okta/vuepress-site/docs/api/postman can not be accessed from developer.okta.com, returning 404.

Example:
https://developer.okta.com/docs/api/postman/example.oktapreview.com.environment

Note:
This collections can be accessed without any issues from okta.github.io, for example https://okta.github.io/docs/api/postman/example.oktapreview.com.environment

Quickstart buttons are broken

In both Chrome and Firefox, clicking on these buttons does nothing:

It works fine in Edge.

Promo banner visited link color

On pages with the quickstart .DocsPromoBanner, the link color is purple if visited. It should not be; the text color should be white.

Article title component

Per @alexdahl-okta, this is what the top of documentation pages should look like (applies to guides and everything else):

We already have the Edit link (currently Edit Page), but we don't have Last Updated.

Extra icon for postman links

There is an extra icon below the orange button that is not present in the prod site:

Add support for "Edit" links

The previous site had "Edit" links that would send the user to GitHub to edit a file and open a Pull Request

Padding/Alignment issue on 3rd_party_notices pages

https://developer.okta.com/3rd_party_notices/
https://developer.okta.com/3rd_party_notices/Okta_Confluence/
https://developer.okta.com/3rd_party_notices/Okta_Auth_SDK/

Highlighted text is invisible

For some reason the highlight color is very dark, which makes dark text impossible to read:

Add a copy button in the language box to copy/paste code samples

As per @nbarbettini , I added this issue after our conversation.

Dev Docs: Event Catalog search is broken

Search on our public event catalog is broken (https://developer.okta.com/docs/api/resources/event-types/#catalog)

This prevents our users from being able to search through our ~600 events to browse and ID events they need for troubleshooting and/or gaining general knowledge about our events.

Might be related to the migration to VuePress

cc: @bobtiernay-okta @bretterer

Broken anchor links on https://developer.okta.com/reference/scim

Many of the anchor links in the right hand nav for /reference/scim do not work, and I think its because the anchor links in the article for certain sections are empty, so its not matching

For instance, the 3rd section for

Read Account Details: GET/users has an anchor of https://developer.okta.com/reference/scim/#read-account-details-get-users-id

But in the article the section link is simply:
https://developer.okta.com/reference/scim/#
sans the sub-section string

Items Missing from Authentication Guide TOC on the left and API Concepts items not alpha

The TOC is missing several items - including social IdPs and the new Generic OIDC IdP.

Also, lower on the page - the API Concepts topics aren't in alpha order for some reason.

Old Site

Vuepress

Right side TOC not populated during direct navigation

Steps to reproduce:

1. visit https://vuepress-site.trexcloud.com/reference/
2. Click on any of the links that take you into an API reference section, e.g. Policy
3. See that the sidebar has no links:
   
4. Reload the page, now the links appear

Compiling Client Build Notice

[4:09:33 PM] Compiling Client

With `useBuiltIns` option, required direct setting of `corejs` option

This happens during yarn dev

Use only vanilla Razor code in aspnet/aspnetcore examples

In these examples: /guides/sign-into-web-app/aspnetcore/get-user-info/

We show classes like dl-horizontal, btn-link btn-xs, and data-clipboard-text which are specific to Bootstrap and clipboard.js. That's what we use in the example app, but we should keep the guide sample code as plain and simple as possible.

@laura-rodriguez Can you modify the guide sample code to show only plain HTML and Razor? We can drop the "copy to clipboard" functionality.

Stack Selector icons and text are oppositely aligned

This appeared after the Nim inclusion, so updates may have to be made there.

Search doesn't always work

Clicking on the "Go" button or pressing Enter in the search box only works intermittently. Sometimes it takes you to the search results page, but other times it doesn't. I haven't been able to nail down why.

Applies only to pages hosted by VuePress.

Event Catalog Query Parameter Not Handled

Before the migration, it was possible to query the event types catalog using the query parameter webhook-eligible, i.e.: https://developer.okta.com/docs/api/resources/event-types?q=webhook-eligible to get the set of event types currently eligible for use in event hooks. Looks like it's not working now.

Link checker not finding 404's

On this page:

https://developer.okta.com/docs/api/resources/oidc/#token-authentication-methods

There is a link to:

https://developer.okta.com/docs/api/resources/oidc/oauth-clients#json-web-key-set

That page doesn't exist, I would expect our link checker to fail on this