Ftps connector edit#45
Open
jordan-modusbox wants to merge 5 commits intolatestfrom
Open
Conversation
…-docs into ftps-connector-edit
IanWhyte
reviewed
Jul 28, 2020
| @@ -1,2 +1,2 @@ | |||
| * xref:ftps-connector.adoc[FTPS Connector User Guide] | |||
|
|
|||
| ** xref:use-case-example.adoc[Use Case Example - Hello World] | |||
Contributor
There was a problem hiding this comment.
I think I'd go with a structure here similar to the one we're talking about for JDE, something like this:
- FTPS Connector User Guide
** Intro
** Prerequisites
** Installation
** Configuration
** Use Cases
** Use Case Example
I think the User Guide page is short enough that you can add the Use Case Example page to it (as an H2, bumping all the headings it contains down a level), but we an talk about that.
IanWhyte
suggested changes
Aug 11, 2020
| A familiar understanding of Mule, | ||
| https://docs.mulesoft.com/anypoint-studio/v/6/download-and-launch-anypoint-studio[Anypoint™ Studio] interface and FTPS is assumed. | ||
|
|
||
| === Namespace |
Contributor
There was a problem hiding this comment.
Need some explanation of what users must do with the code.
Contributor
Author
There was a problem hiding this comment.
Will consult with Fer about the use of code. Found docs in MuleSoft that may be useful
| == Configuration | ||
|
|
||
| To configure the FTPS connector, determine your endpoint configuration needs. See the Hello World application below for a configuration example. | ||
| To configure the FTPS Connector, determine your endpoint configuration needs. See the xref:use-case-example.adoc[Hello World] use case example for a configuration example. |
| See the xref:use-case-example.adoc[Hello World] use case example for information on how to use and configure the FTPS connector. | ||
|
|
||
| === Use Cases | ||
|
|
Contributor
There was a problem hiding this comment.
All bullets in this section are complete sentences, so end them all with periods.
| In this example, the connector reads a file over FTPS and saves its contents locally. | ||
|
|
||
|
|
||
| . Create a new Mule Project using Mule Server 3.6.0 EE as runtime. |
Contributor
There was a problem hiding this comment.
In order to be consistent with the PortX library, in which we:
- Provide an instruction
- Show the screen that appears as a result of the instruction
- Provide the next instruction, most likely referring to the screen above the current instruction.
...The appropriate way to sequence these instructions and screens starts with:
- Copy the "Create a Mule..." step and paste it below the screenshot.
- Then, change this step to something like "In Anypoint Studio, navigate to the Project Settings Page." (I'm assuming this is Anypoint Studio, but we should confirm.)
- Move all subsequent steps one spot down, as you did in Step 1 here.
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
FTPS update and edit. Open for review