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.

Sign up for GitHub

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

Jump to bottom

feat: Style API Portal and add templating mechanism #2965

Merged
merged 63 commits into from
Jul 11, 2023
Merged

feat: Style API Portal and add templating mechanism #2965

merged 63 commits into from
Jul 11, 2023

Conversation

taban03
Copy link
Contributor

@taban03 taban03 commented Jun 28, 2023 •
edited
Loading

Description

Style API Portal based on the wireframe.
Add UI customisation via service configuration.
Make UI responsive
Enhance the search bar to filter by api doc information (i.e endpoints) and not only by service title.

Linked to #2802
Part of the # (epic)

Type of change

Please delete options that are not relevant.

  • (fix) Bug fix (non-breaking change which fixes an issue)
  • (feat) New feature (non-breaking change which adds functionality)
  • (docs) Change in a documentation
  • (refactor) Refactor the code
  • (chore) Chore, repository cleanup, updates the dependencies.
  • (BREAKING CHANGE or !) Breaking change (fix or feature that would cause existing functionality to not work as expected)

Checklist:

  • My code follows the style guidelines of this project
  • I have performed a self-review of my own code
  • I have commented my code, particularly in hard-to-understand areas. In JS I did provide JSDoc
  • I have made corresponding changes to the documentation
  • My changes generate no new warnings
  • I have added tests that prove my fix is effective or that my feature works
  • New and existing unit tests pass locally with my changes
  • The java tests in the area I was working on leverage @nested annotations
  • Any dependent changes have been merged and published in downstream modules

For more details about how should the code look like read the Contributing guideline

taban03 and others added 26 commits June 16, 2023 10:49
@taban03 @bl893166
Include Brian changes for the templating (#2956)
8923a08 
* new styles initial commit

* swagger cont

* css changes

* spacing

* fix html

* update token

---------

Co-authored-by: Brian Lee <[email protected]>
@taban03
revert back
97d4317 
Signed-off-by: at670475 <[email protected]>
@taban03
resolve conflicts
daf1df2 
Signed-off-by: at670475 <[email protected]>
@taban03
flag the css for zowe and portal
54240fb 
Signed-off-by: at670475 <[email protected]>
@taban03
add backend parameters mapping
b5e0b0a 
Signed-off-by: at670475 <[email protected]>
@taban03
cleanup
bb01c76 
Signed-off-by: at670475 <[email protected]>
@taban03
fix conditional flag check
14ecb62 
Signed-off-by: at670475 <[email protected]>
@taban03
wip - fix css
87df95b 
Signed-off-by: at670475 <[email protected]>
@taban03
wip
49ab741 
Signed-off-by: at670475 <[email protected]>
@taban03
adjust css
b73ef93 
Signed-off-by: at670475 <[email protected]>
@taban03
wip
1f9ab7a 
Signed-off-by: at670475 <[email protected]>
@taban03
add links
984d965 
Signed-off-by: at670475 <[email protected]>
@taban03
define branding function
3df5845 
Signed-off-by: at670475 <[email protected]>
@taban03
footer links
0c7eeff 
Signed-off-by: at670475 <[email protected]>
@taban03
count number of footer content
01d66e5 
Signed-off-by: at670475 <[email protected]>
@taban03
fix issues and add move footer
c82f954 
Signed-off-by: at670475 <[email protected]>
@taban03
fix css
c01d97b 
Signed-off-by: at670475 <[email protected]>
@taban03
flag the css for zowe and portal
b27b764 
Signed-off-by: at670475 <[email protected]>
@taban03
fix test
04f0c16 
Signed-off-by: at670475 <[email protected]>
@taban03
small fix
7955cbd 
Signed-off-by: at670475 <[email protected]>
@taban03
fix bug with version dropdown menu empty
bb1e8b6 
Signed-off-by: at670475 <[email protected]>
@taban03
open link on new tab
aedf6a9 
Signed-off-by: at670475 <[email protected]>
@taban03
small fix
5883a6f 
Signed-off-by: at670475 <[email protected]>
@taban03
make rsponsiveness
614577a 
Signed-off-by: at670475 <[email protected]>
@taban03
responsiveness
fc2122b 
Signed-off-by: at670475 <[email protected]>
@taban03
responsive
0e3d58f 
Signed-off-by: at670475 <[email protected]>
@taban03
fix css
3f2dfe6 
Signed-off-by: at670475 <[email protected]>
@taban03 taban03 marked this pull request as draft June 28, 2023 09:25
@taban03
define mock custom config in tests
4ceeb1a 
Signed-off-by: at670475 <[email protected]>
@taban03
increase coverage
db47831 
Signed-off-by: at670475 <[email protected]>
@taban03
fix
5c789fb 
Signed-off-by: at670475 <[email protected]>
@taban03
address pr comments
1c5c506 
Signed-off-by: at670475 <[email protected]>
@taban03
fix font family config
d7898ce 
Signed-off-by: at670475 <[email protected]>
@taban03
address PR comments
db97d4c 
Signed-off-by: at670475 <[email protected]>
pablocarle
pablocarle reviewed Jul 11, 2023
View reviewed changes
Copy link
Contributor

@pablocarle pablocarle left a comment

Choose a reason for hiding this comment

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

I took the liberty of creating an issue for the Google Chrome / Firefox support in docs-site zowe/docs-site#2985

@sonarcloud
Copy link

sonarcloud bot commented Jul 11, 2023

Kudos, SonarCloud Quality Gate passed!    Quality Gate passed

Bug A 0 Bugs
Vulnerability A 0 Vulnerabilities
Security Hotspot A 0 Security Hotspots
Code Smell A 0 Code Smells

88.4% 88.4% Coverage
0.0% 0.0% Duplication

@taban03 taban03 merged commit b286cef into v2.x.x Jul 11, 2023
32 of 33 checks passed
@delete-merged-branch delete-merged-branch bot deleted the reboot/style_api_portal branch July 11, 2023 12:42
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@pablocarle pablocarle pablocarle approved these changes

Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
2 participants
@taban03 @pablocarle