Skip to content

Use docfx for documentation autogeneration #799

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom
Closed
glennsarti opened this issue Nov 26, 2018 · 2 comments
Closed

Use docfx for documentation autogeneration #799

glennsarti opened this issue Nov 26, 2018 · 2 comments
Assignees
@andyleejordan
Labels
Area-Documentation Issue-Enhancement A feature request (enhancement). Resolution-Answered Will close automatically.

Comments

@glennsarti
Copy link
Contributor

glennsarti commented Nov 26, 2018 •
edited
Loading

The old API website (http://powershell.github.io/PowerShellEditorServices/) is very very old (14 May 2016). This issue is to track the work to revive the automated document generation
glennsarti added a commit to glennsarti/PowerShellEditorServices that referenced this issue Nov 26, 2018
@glennsarti
(PowerShellGH-799) Revive docfx scripts
41d340f 
Previously the document generation scripts for docfx were broken e.g. Unable to
download docfx from github due to TLS.  This commit;
* Updates the BuildDocs script to properly clean and download docfx from Github
* Updates the docfx.json file to use the correct naming (cwd -> src) and to
  use the correct project files
* Updates gitignore to ignore docfx working directory
* Adds two build tasks (BuildDocs and ServeDocs) to build and serve
  autogenerated documentation
* Adds additional configuration switch for Invoke-Build for legacy applications,
  like docfx, which use MSBuild as a library but it needs the dotNet Core
  versions of MSBuild instead of VS 2015/2017
glennsarti added a commit to glennsarti/PowerShellEditorServices that referenced this issue Nov 26, 2018
@glennsarti
(PowerShellGH-799) Revive docfx scripts
9156e6c 
Previously the document generation scripts for docfx were broken e.g. Unable to
download docfx from github due to TLS.  This commit;
* Updates the BuildDocs script to properly clean and download docfx from Github
* Updates the docfx.json file to use the correct naming (cwd -> src) and to
  use the correct project files
* Updates gitignore to ignore docfx working directory
* Adds two build tasks (BuildDocs and ServeDocs) to build and serve
  autogenerated documentation
* Adds additional configuration switch for Invoke-Build for legacy applications,
  like docfx, which use MSBuild as a library but it needs the dotNet Core
  versions of MSBuild instead of VS 2015/2017
glennsarti added a commit to glennsarti/PowerShellEditorServices that referenced this issue Nov 26, 2018
@glennsarti
(PowerShellGH-799) Revive docfx scripts
bd55b82 
Previously the document generation scripts for docfx were broken e.g. Unable to
download docfx from github due to TLS.  This commit;
* Updates the BuildDocs script to properly clean and download docfx from Github
* Updates the docfx.json file to use the correct naming (cwd -> src) and to
  use the correct project files
* Updates gitignore to ignore docfx working directory
* Adds two build tasks (BuildDocs and ServeDocs) to build and serve
  autogenerated documentation
* Adds additional configuration switch for Invoke-Build for legacy applications,
  like docfx, which use MSBuild as a library but it needs the dotNet Core
  versions of MSBuild instead of VS 2015/2017
@SydneyhSmith SydneyhSmith added Area-Documentation Issue-Enhancement A feature request (enhancement). labels Nov 27, 2018
glennsarti added a commit to glennsarti/PowerShellEditorServices that referenced this issue Nov 28, 2018
@glennsarti
(PowerShellGH-799) Revive docfx scripts
f8575be 
Previously the document generation scripts for docfx were broken e.g. Unable to
download docfx from github due to TLS.  This commit;
* Updates the BuildDocs script to properly clean and download docfx from Github
* Updates the docfx.json file to use the correct naming (cwd -> src) and to
  use the correct project files
* Updates gitignore to ignore docfx working directory
* Adds two build tasks (BuildDocs and ServeDocs) to build and serve
  autogenerated documentation
* Adds additional configuration switch for Invoke-Build for legacy applications,
  like docfx, which use MSBuild as a library but it needs the dotNet Core
  versions of MSBuild instead of VS 2015/2017
glennsarti added a commit to glennsarti/PowerShellEditorServices that referenced this issue Nov 28, 2018
@glennsarti
(PowerShellGH-799) Remove redundant code
e7e0485 
This commit removes redundant code from the build scripts.
glennsarti added a commit to glennsarti/PowerShellEditorServices that referenced this issue Nov 28, 2018
@glennsarti
(PowerShellGH-799) Revive docfx scripts
8165b87 
Previously the document generation scripts for docfx were broken e.g. Unable to
download docfx from github due to TLS.  This commit;
* Updates the BuildDocs script to properly clean and download docfx from Github
* Updates the docfx.json file to use the correct naming (cwd -> src) and to
  use the correct project files
* Updates gitignore to ignore docfx working directory
* Adds two build tasks (BuildDocs and ServeDocs) to build and serve
  autogenerated documentation
* Adds additional configuration switch for Invoke-Build for legacy applications,
  like docfx, which use MSBuild as a library but it needs the dotNet Core
  versions of MSBuild instead of VS 2015/2017
glennsarti added a commit to glennsarti/PowerShellEditorServices that referenced this issue Nov 28, 2018
@glennsarti
(PowerShellGH-799) Remove redundant code
4ce1676 
This commit removes redundant code from the build scripts.
glennsarti added a commit to glennsarti/PowerShellEditorServices that referenced this issue Nov 28, 2018
@glennsarti
(PowerShellGH-799) Revive docfx scripts
ddb4899 
Previously the document generation scripts for docfx were broken e.g. Unable to
download docfx from github due to TLS.  This commit;
* Updates the BuildDocs script to properly clean and download docfx from Github
* Updates the docfx.json file to use the correct naming (cwd -> src) and to
  use the correct project files
* Updates gitignore to ignore docfx working directory
* Adds two build tasks (BuildDocs and ServeDocs) to build and serve
  autogenerated documentation
* Adds additional configuration switch for Invoke-Build for legacy applications,
  like docfx, which use MSBuild as a library but it needs the dotNet Core
  versions of MSBuild instead of VS 2015/2017
glennsarti added a commit to glennsarti/PowerShellEditorServices that referenced this issue Nov 28, 2018
@glennsarti
(PowerShellGH-799) Remove redundant code
570d0c6 
This commit removes redundant code from the build scripts.
@andyleejordan andyleejordan self-assigned this May 13, 2021
@andyleejordan
Copy link
Member

Closing this out as we actually chose to close the website itself, the documentation is in the repo.

@andyleejordan andyleejordan added the Resolution-Answered Will close automatically. label Feb 9, 2023
@ghost ghost closed this as completed Feb 10, 2023
@ghost
Copy link

ghost commented Feb 10, 2023

This issue has been marked as answered and has not had any activity in a day. It has been automatically closed for housekeeping purposes.

This issue was closed.
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees

@andyleejordan andyleejordan

Labels
Area-Documentation Issue-Enhancement A feature request (enhancement). Resolution-Answered Will close automatically.
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
3 participants
@andyleejordan @glennsarti @SydneyhSmith