Skip to content

(doc): migrate to eta from ejs#11102

Merged
christian-bromann merged 4 commits intowebdriverio:mainfrom
tamil777selvan:doc-fix
Sep 6, 2023
Merged

(doc): migrate to eta from ejs#11102
christian-bromann merged 4 commits intowebdriverio:mainfrom
tamil777selvan:doc-fix

Conversation

@tamil777selvan
Copy link
Member

@tamil777selvan tamil777selvan commented Sep 5, 2023

Proposed changes

Fix - #6640

  • migrate to eta from markdox & ejs

Types of changes

  • Bugfix (non-breaking change which fixes an issue)
  • New feature (non-breaking change which adds functionality)
  • Breaking change (fix or feature that would cause existing functionality to not work as expected)
  • Documentation update

Checklist

  • I have read the CONTRIBUTING doc
  • I have added tests that prove my fix is effective or that my feature works
  • I have added necessary documentation (if appropriate)
  • I have added proper type definitions for new commands (if appropriate)

Further comments

Reviewers: @webdriverio/project-committers

@christian-bromann
Copy link
Member

@tamil777selvan thanks for taking a stab at this. I am not sure if mustache is a good choice. It hasn't seen any release for more than 2 years and seems like abandoned to me. Any chance we can use eta which is one I've been using in the past and very liked.

@tamil777selvan
Copy link
Member Author

Hi @christian-bromann, I followed your advice and started using ETA. Could you please take a look at it whenever you get a chance? Thank you!

@tamil777selvan tamil777selvan changed the title (doc): migrate to mustache from ejs (doc): migrate to eta from ejs Sep 6, 2023
Copy link
Member

@christian-bromann christian-bromann left a comment

Choose a reason for hiding this comment

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

Can we also remove the postinstall:vulnerabilities command and the file connected to it?

The rest looks good to me, great job!

Comment on lines +19 to +21
<% /* This protocol command is embedded in the following convenient method<%= it.alternativeCommands.length > 1 ? 's' : '' %>: <% for (const altCommand of it.alternativeCommands) { %>[<%= altCommand.split('/').pop() %>](/docs/api/<%= altCommand %>)<% } %>. It is recommended to use <%= it.alternativeCommands.length > 1 ? 'these commands' : 'this command' %> instead. */ %>

This protocol command is embedded in the following convenient method<%= it.alternativeCommands.length > 1 ? 's' : '' %>: <%= it.alternativeCommands.map((command) => `[${command.split('/').pop()}}](/docs/api/${command})`).join(', ') %>. It is recommended to use <%= it.alternativeCommands.length > 1 ? 'these commands' : 'this command' %> instead.
Copy link
Member

Choose a reason for hiding this comment

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

Suggested change
<% /* This protocol command is embedded in the following convenient method<%= it.alternativeCommands.length > 1 ? 's' : '' %>: <% for (const altCommand of it.alternativeCommands) { %>[<%= altCommand.split('/').pop() %>](/docs/api/<%= altCommand %>)<% } %>. It is recommended to use <%= it.alternativeCommands.length > 1 ? 'these commands' : 'this command' %> instead. */ %>
This protocol command is embedded in the following convenient method<%= it.alternativeCommands.length > 1 ? 's' : '' %>: <%= it.alternativeCommands.map((command) => `[${command.split('/').pop()}}](/docs/api/${command})`).join(', ') %>. It is recommended to use <%= it.alternativeCommands.length > 1 ? 'these commands' : 'this command' %> instead.
This protocol command is embedded in the following convenient method<%= it.alternativeCommands.length > 1 ? 's' : '' %>: <%= it.alternativeCommands.map((command) => `[\`${command.split('/').pop()}\`](/docs/api/${command})`).join(', ') %>. It is recommended to use <%= it.alternativeCommands.length > 1 ? 'these commands' : 'this command' %> instead.

@tamil777selvan
Copy link
Member Author

Can we also remove the postinstall:vulnerabilities command and the file connected to it?

I have updated it @christian-bromann, please have a look. Thanks!

Copy link
Member

@christian-bromann christian-bromann left a comment

Choose a reason for hiding this comment

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

Awesome, LGTM 👍

@christian-bromann christian-bromann added the PR: Docs 📝 PRs that contain changes to the documentation label Sep 6, 2023
@christian-bromann christian-bromann merged commit a1ecb21 into webdriverio:main Sep 6, 2023
@tamil777selvan tamil777selvan deleted the doc-fix branch September 6, 2023 05:19
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

PR: Docs 📝 PRs that contain changes to the documentation

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants