Distribution page layout

[IronRico]

This issue has a few components to address.

Taking a look at the following section of the guide first.

When looking at the left-hand navigation options for the guide, you will see the following structure.

Currently, there is an Online Transfer option that is not listed in that set above. It should go above the Offline Transfer option.

• Distribution Section
  • Distribution Edit Window
  • Distributor Edit Window
    • Transfer Option
      • Online Transfer
      • Offline Transfer
      • Distribution Format
• Order Process

---

As for the Online Transfer section, Here is the screenshot as it appears in the guide currently:

Here is how it appears in the current mdEditor version:

---

I noticed that there are two parts that are different, those at the end.
• Application Profile
• Protocol Request

These would need to be added to the Online Transfer page with relevant information.

Application Profile seems to just be the name of the API itself being used.
Protocol Request seems in turn to just be the request time being made to the API, (POST, GET, PUT, or possibly even DELETE).

---

Please provide any input you may have on this topic.

[IronRico]

I have not requested a pull request on this, however, I did do some mock-up work in my own repo to see how this would look.

Here is a screenshot of the Online Transfer option page.

I would like input on the details of the bullet items, as to what proper wording would be wanted, ( or unwanted).

---

I also tested linking the page in the sidebar by editing the Summary.md file. When I ran locally on my machine, it seemed to work without issue.

---

Please advise if this would have any negative issues using this method.

[IronRico]

"Time Duration Object" or "Transfer Frequency"?

On the Distribution page, I noted that there are these two sections that I assume are one in the same with different names. I added screenshots below.

---

Are these indeed the same item only with different names, or are these totally separate?

[hmaier-fws]

Nope, they're different. The attribute is "transfer frequency" which is a "time duration" object type. Just as the Online Resource "Name", "Protocol" and "Description" attributes are all of type "string".

[IronRico]

Second Update

Here is a screenshot of the Distribution section. I removed the Online Transfer and Time Duration Object items from the bottom and made them their own page. The links in-page work when tested on my localhost server as well.

---

Here you can see the side navigation for those new areas.

---

Here you can see the Online Transfer section.

---

This is the Transfer Frequency page.

---

Please advise on the details of these items to help refine the tone or proper wording.

[IronRico]

Pull Request Review

Before submitting a pull request, I wanted to submit some of the changes I have made on the dev branch of my fork.

---

Changed the "Summary.md" file to show the new page navigation options
under "Transfer Option".

These options are "Online Transfer Option" and "Transfer Frequency".

I created a page for Transfer Frequency. I used the same name for the file that
was already in use, ("timeDuration-obj").

The path for this file is here:
mdEditor-doc/reference/edit-window/metadata/distribution-panels/timeDuration-obj.md

The page for the "Online Transfer Option" is found here:
mdEditor-doc/reference/edit-window/metadata/distribution-panels/onlineTransferOption.md

Edited the "Transfer Option" page located here:
mdEditor-doc/reference/edit-window/metadata/distribution-panels/transferOption.md

For that page, I removed the “Online Option” and “Time Duration” sections that were
found at the bottom.

Updated the "Online Transfer Option" screenshot. It is located here:
assets/reference/edit-objects/metadata/distribution/OnlineTransferOption.png

[jlblcc]

This looks fine. Are you using the https://github.com/adiwg/mdEditor-doc/blob/master/reference/include-objects?

[IronRico]

I corrected the use of include-objects and also made sure the links in the Distribution section were working as well.

EDIT:

After running the build again, I noticed I cannot click on the link to open the correct page. It seems to know where to go as it will open in another window or allow me to save the markdown file. However, it will not open on click as with "offlineTransferOption". I am working to see what caused this issue.

[IronRico]

Update 3

I worked to correct the navigation issues found in the Distribution section of the Summary.md file.

I replaced these with the following:

[Online Transfer Option](reference/edit-window/metadata/distribution-panels/ onlineTransferOption.md)
[Transfer Frequency] (reference/edit-window/metadata/distribution-panels/ timeDuration-obj.md)

I tested these items locally and found them to be working as intended.

This is noted in the rolling doc changes as well.