wso2 / wso2/docs-apim

Doc Feedback: Incomplete Tutorial Customizing Task Scheduling

Open
#4,122 2 comments 0 reactions 1 assignee View on GitHub

@nandika is already working on this.

Since Jun 18, 2021.

API-M-4.0.0 help wanted Severity/Major Type/Bug
Dominant language
CSS
Stars
99
Forks
708
Avg merge
1d 7h
Merged PRs (30d)
22

Description

Location : https://apim.docs.wso2.com/en/latest/integrate/develop/customizations/creating-custom-task-scheduling/

Section: Creating the Maven Project
Content: Create a Maven Project using the following information.
! No Information follows !

There is a "Tip" just after the text, which probably applies to some resources that were linked in previous versions.

The two "Deploy" sections also seem to be incomplete. At the very least, a link to an actual description is necessary. The current text is infuriatingly useless.

Section: Creating the Task
The note:
"!!! Note Currently, you cannot set properties of a custom task using the Design View due to a known issue, which will be fixed in future versions."
refers to an issue that was closed over two years ago.

Creating an empty variable, as described in the table just at the end of the section "Creating the Task", is not possible. The variable is removed automatically.

The XML described with "The below is the complete source configuration" is probably wrong. Instead of class="org.apache.synapse.startup.tasks.MessageInjector" it probably should be class="org.wso2.task.stockquote.v1.StockQuoteTaskV1". Though, I cannot get either version working.

Section: Starting the back-end service
"Download the backend service from GitHub and run it." is not self-explanatory. The jar cannot be started with java -jar stockquote-deplorable-jar-2.2.2.jar. What additional dependencies are required?

Contributor guide

No contributing guide indexed for this repository

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Assessment

This issue has not been assessed yet.

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.