Opened 3 years ago

Closed 3 years ago

#1229 closed task (invalid)

Copy updated corfunc_help to Github for new website docs

Reported by: smk78 Owned by: mathieu
Priority: blocker Milestone: SasView 4.2.1
Component: SasView Keywords:
Cc: Work Package: SasView Documentation

Description

The corfunc_help.rst committed to fix #1225 needs copying to https://github.com/SasView/docs for the new online documentation (see Ricardo's email to developers of 11/02/19).

Change History (3)

comment:1 Changed 3 years ago by butler

As mentioned on closing ticket #1227 this is not how the docs should be handled. I am leaving this open for now nonetheless for discussion at Tuesday's meeting. Assuming that the doc change which was a 4.3 ticket not a 4.2.1 ticket, remains a fix to 4.3, one could cheat and replace this and the appropriate index file I guess to effectively slip in some changes under the radar. Not sure that is a good precedent to set but…. ?

comment:2 Changed 3 years ago by smk78

I wasn't aware that the website change had also altered how we deploy the documentation. This ticket and #1227 were therefore trying to ensure that the bundled documentation and the web documentation were in synch as per the instructions in /tutorials/README.md If we now have full auto-deployment and these instructions are deprecated, great!

comment:3 Changed 3 years ago by butler

  • Resolution set to invalid
  • Status changed from new to closed

Lots of confusion with the new website structure. The docs are a strict copy of the release docs folder. Any file additions changes need to be made in SasView prior to release and built by sphinx during the build process. Since the release process started on Feb 10 it has been agree that these changes will be part of 4.3 (or whatever the next release is). Thus closing this ticket as invalid (cannot copy an rst file to the docs repo)

Note: See TracTickets for help on using tickets.