Re: [app-dev] [integration-dev] OFP docs changes


Luis Gomez
 

Hi Dhiraj,

FYI your patch for operations.rst is merged, please continue with the other files.

BR/Luis

On Jul 23, 2020, at 8:20 AM, Dhiraj Sharma <dhiraj.8.sharma@...> wrote:

Awesome, I will apply the changes sir.



Thank You
Dhiraj Sharma

On Jul 23, 2020 20:39, "Luis Gomez" <ecelgp@...> wrote:
Yes Dhiraj, it looks good now.

Can you please extend the tab example in this patch: https://git.opendaylight.org/gerrit/c/openflowplugin/+/90547 to all the REST bodies in the same file?

After that, we can +1 the patch and send for approval/merge. Once the patch is merged, you can continue working in other REST bodies in other files.

BR/Luis


On Jul 23, 2020, at 6:00 AM, Dhiraj Sharma <dhiraj.8.sharma@...> wrote:

Respected Sir,

 Are new changes in OPF documentation good.
Should I apply it on all the required fields?


Thank You
Dhiraj Sharma

On Jul 17, 2020 10:26, "Dhiraj Sharma via lists.opendaylight.org" <dhiraj.8.sharma=gmail.com@lists.opendaylight.org> wrote:
Got the point sir, I will push once the UI looks correct.
As of now the changes didn't look same as we expected.

On Jul 17, 2020 08:26, "Luis Gomez" <ecelgp@...> wrote:
According to this: https://github.com/djungelorm/sphinx-tabs, you have to use code-tabs. Also when you use code-tabs, make sure you use same indent as in the examples in this github, otherwise the table will not look good.

BR/Luis

> On Jul 16, 2020, at 7:05 PM, Dhiraj Sharma <dhiraj.8.sharma@...> wrote:
>
> Hello sir, with code-tab it was working you can check the previous patch.
>
> But in this new patch with tab it is giving errors as extra line spaces are required at each node and termination as it is XML and JSON codes which are providing issues.
> I used tab as per Tejas sir reviews.
>
>
> ThaK You
> Dhiraj
>
> On Jul 17, 2020 6:56 AM, "Luis Gomez" <ecelgp@...> wrote:
> Hi Dhiraj,
>
> The patch failed, are you facing more issues?
>
>> On Jul 14, 2020, at 8:33 PM, Dhiraj Sharma <dhiraj.8.sharma@...> wrote:
>>
>> Hello Sir,
>>
>> I have updated the patch now  https://git.opendaylight.org/gerrit/c/openflowplugin/+/90547
>>
>>
>>
>> On Tue, Jul 14, 2020 at 10:30 PM Tejas Nevrekar <tejas.nevrekar@...> wrote:
>> Dhiraj, can you please check this example https://github.com/djungelorm/sphinx-tabs/blob/master/example/index.rst?
>>
>> I think you need to use tab and not code-tab for the json and xml.
>>
>> On Tue, Jul 14, 2020, 4:09 PM Dhiraj Sharma <dhiraj.8.sharma@...> wrote:
>> Sorry for being late please check the changes at first payload as a demo and you can review that part where I will apply changes subsequently to other payloads likewise.Both in flow-examples and operation.rst files.
>>
>> https://git.opendaylight.org/gerrit/c/openflowplugin/+/90547
>>
>>
>>
>> Thank You
>> Dhiraj
>>
>> On Tue, Jul 14, 2020 at 10:33 AM Dhiraj Sharma <dhiraj.8.sharma@...> wrote:
>> Yes sure, I will push changes asap.
>>
>> On Jul 14, 2020 10:07 AM, "Luis Gomez" <ecelgp@...> wrote:
>> Dhiraj, can you please push the change to gerrit and share the link so we can take a look?
>>
>>> On Jul 13, 2020, at 9:14 PM, Dhiraj Sharma <dhiraj.8.sharma@...> wrote:
>>>
>>>
>>> So are you saying current version of sphinx in ODL Jenkins (3.0.4) is not compatible with the tabs plugin? do you have a jenkins rtd job failing for this reason? if so can you share the link?
>>>
>>> BR/Luis
>>>
>>> Hello Sir,
>>>  I thought that rtdd jenkins may fail, if I use sphinx tabs as locally tox was emitting error. But the problem was with cached ".tox" which after deletion worked fine but UI is not as expected.
>>>
>>>
>>> Works just fine with the sphinx-tabs basic example from their site. Here was my quick test with the odl documentation project:
>>>
>>> https://git.opendaylight.org/gerrit/c/docs/+/91311/1/docs/documentation.rst
>>>
>>> (Although our current bootstrap theme does not appear to render the tabs in a nice way, but it works.)
>>>
>>> Dhiraj,
>>>
>>> If you already ran docs builds _before_ sphinx-tabs support was merged (tox -e docs) then you need to clear your cache by deleting the .tox directory in the repo. Otherwise it might use the old cached requirements and may not pick up the new tabs support.
>>>
>>> Regards,
>>> Thanh
>>>
>>> Thank You for the example sir, I worked similarly.The problem was with the stored cached directory of ".tox" which I used to build earlier.
>>> After deleting and then again testing yields the output but the UI is not the same as expected.
>>>
>>> Please check below attached screenshots where I tried https://git.opendaylight.org/gerrit/c/docs/+/91311/1/docs/documentation.rst#23 too.
>>> The "code-tab" is also not showing the JSON tab in the below screenshot.
>>> So, even if the UI is not that same should I push the changes?
>>>
>>> Thank You
>>> Dhiraj Sharma
>>> <Screenshot (462).png><Screenshot (463).png>
>>
>










Join integration-dev@lists.opendaylight.org to automatically receive all group messages.