Thanks to visit codestin.com
Credit goes to github.com

Skip to content

Conversation

@EdvinOlofsson
Copy link
Collaborator

Modernize WebUI development documentation with working vanilla JS examples

  • Convert examples from jQuery to ES6+ JavaScript
  • Add working Comet channel implementation for push notifications
  • Update docs

@EdvinOlofsson EdvinOlofsson self-assigned this Nov 10, 2025
Copy link
Member

@cohult cohult left a comment

Choose a reason for hiding this comment

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

NIce!

@EdvinOlofsson
Copy link
Collaborator Author

@cohult Did you read the changes carfully? I am a documentation novice and didn't get that gitbook plugin for pretty code rendering to work.. So I hope formatting and styling looks proper.

Copy link
Collaborator

@ahcsco ahcsco left a comment

Choose a reason for hiding this comment

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

Just noticed a need for couple of small corrections.

@cohult
Copy link
Member

cohult commented Nov 11, 2025

@EdvinOlofsson , to spare us from checking formatting and styling, you can merge your markdown to the test-n-play branch and then to go to the gitbook editor for a preview: https://app.gitbook.com/o/zCWEO4HUVOjwxqT5Hla6/s/MCFXLJGKRQEW4n8TBkyC/development/advanced-development/web-ui-development/json-rpc-api
Although, you have five simple gitbook extensions in there, four "code title" and one "hint". They all look ok to me. The rest is generic markdown which the GitHub markdown renderer can preview for you.
https://github.com/NSO-developer/nso-gitbook/blob/eolofsso/ENG-37149-webui-doc/development/advanced-development/web-ui-development/README.md

@cohult
Copy link
Member

cohult commented Nov 11, 2025

@EdvinOlofsson , Also, since you are editing only a single Markdown page here and you want to preview the five GitBook extensions, next time I suggest you use the GitBook editor to make the changes. After you merged the changes done in the GitBook editor to main, you can get the commit id from here (GitHub) and cherry-pick when backporting to 6.6, 6.5, 6.4 etc branches.

@EdvinOlofsson
Copy link
Collaborator Author

I see your suggestions @cohult Thanks for the detailed tips!
Yes, I was only using github editor and previews... In the future I will try the Gitbook editor and test-n-play branch (smart idea!)

@EdvinOlofsson
Copy link
Collaborator Author

EdvinOlofsson commented Nov 12, 2025

I've pushed PR feedback fixes now. (minor typos, thanks for reading carefully!)
When merging I plan to do squash-and-merge. Any special commit messages format or is this commit message good enough?:
[ENG-37149] Modernizing WeUI development documentation README.md file

@cohult
Copy link
Member

cohult commented Nov 12, 2025

@EdvinOlofsson, definitely good enough. The more we use the tailf repo type of commit messages and branch names the better. Good to point to the ENG ticket.

@EdvinOlofsson EdvinOlofsson merged commit e8e9a26 into main Nov 13, 2025
1 check passed
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

Successfully merging this pull request may close these issues.

4 participants