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

Missing documentation on menu on the Dev Portal configuration files #4098

Open
2 tasks done
rLitto opened this issue Jul 7, 2022 · 2 comments
Open
2 tasks done

Missing documentation on menu on the Dev Portal configuration files #4098

rLitto opened this issue Jul 7, 2022 · 2 comments

Comments

@rLitto
Copy link
Contributor

rLitto commented Jul 7, 2022

Where is the problem?

https://docs.konghq.com/gateway/latest/developer-portal/structure-and-file-types/

What happened?

We discovered that there is a menu configuration in the portal.cli.conf that is undocumented

What did you expect to happen?

To find documentation on the menu section of the portal.cli.conf

Code of Conduct and Community Expectations

  • I agree to follow this project's Code of Conduct
  • I agree to abide by the Community Expectations
@rLitto
Copy link
Contributor Author

rLitto commented Jul 7, 2022

Downloaded the portal files for a new file

name: Kong Portal
app_version: 4574611
theme:
  name: base
redirect:
  unauthenticated: login
  unauthorized: unauthorized
  login: dashboard
  logout: ''
  pending_approval: ''
  pending_email_verification: ''

# main menu 
menu:
  - title: Catalog
    url: documentation
    needs_auth: false
  - title: My Apps
    url: applications
    needs_auth: true
  - dynamic_title: user.get("email")
    url: settings
    needs_auth: true
    sub_menu:
      - title: Dashboard
        url: dashboard
        needs_auth: true
      - title: Logout
        url: logout
        needs_auth: true     
  - title: Login
    url: login
    needs_auth: false
    hide_when_authenticated: true
  - title: Sign up
    url: register
    needs_auth: false
    hide_when_authenticated: true
    css_classes:
    - nav-button
    - btn
    - btn-secondary


# main menu if authentication is not enabled in dev portal 
menu_no_auth:
  - title: Catalog
    url: documentation
    needs_auth: false

# menu examples
# menu:    
#   - title: Catalog
#     url: documentation
#     needs_auth: false
#   - title: Public
#     url: partners
#     needs_auth: false
#   - title: Auth
#     url: partners
#     needs_auth: true
#   - title: Auth and role
#     url: partners
#     needs_auth: true
#     needs_role: Partners
#   - title: With submenu
#     url: partners
#     needs_auth: false
#     sub_menu:
#       - title: Sub Entry
#         url: sub-page1
#         needs_auth: false
#       - title: Sub Auth
#         url: sub-page2
#         needs_auth: true     
#   - title: My Apps
#     url: applications
#     needs_auth: true

that is used in the themes/base/partials/menu.html file used in the themes/base/partials/header.html
but there is no reference for the menu

@afzal442
Copy link
Contributor

Hi, LMK how we can document that.

/assign

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

2 participants