GridProtectionAlliance / openPDC

Open Source Phasor Data Concentrator
MIT License
128 stars 59 forks source link

Some Wiki Documentation URL not access #114

Closed avs009 closed 5 years ago

avs009 commented 5 years ago

Hi, Some links in Wiki Documentation not open to read, and say "You do not have permission to update this wiki." or not exist no matter if you are logged or not.

The following links say "You do not have permission to update this wiki.":

  1. Getting Started

  2. Frequently Asked Questions

  3. Use and Configuration Guides

  4. Overview of the openPDC Management System

  5. How to Use the openPDC Manager

  6. Running openPDC on Linux / Mac

  7. Running openPDC on a Raspberry Pi

  8. Data Quality Reporting Services

  9. Custom Point Tag Naming Convention

  10. Enabling Security for Historian Web Services

  11. The GEP Subscription Tester

  12. Running the openPDC in Virtual Machine

  13. Moving Historian to Another Location

  14. Using a "Gateway Style Connection" between openPDCs and/or openPGs

  15. Controlling UDP data loss

  16. Remote Console Security

  17. Help Me Choose Diagrams

  18. Configuration File Settings

  19. Setting for Uniform CPU Utilization

  20. openPDC Console Commands to Adjust Configuration Settings

  21. openPDC OSI-PI Adapters

  22. Data Quality Monitoring Adapters

  23. Adapter Connection String Syntax

  24. Distributed Historian Setup Notes

  25. Automated Archive Data Recovery Operation

  26. Automated Connection Failover Operation

  27. Adjusting Output Stream Labels to Meet ISO Naming Standard

  28. How to Manually Configure the openPDC

  29. How to Bulk Apply line-to-line Sqrt(3) Adjustment to all Voltage Magnitudes

  30. Single Page Overview

    Developer's Documentation

  31. Getting Started

  32. Frequently Asked Questions

  33. Build the openPDC Manager

  34. Data Access Options for the openPDC

  35. Device to Data in 5 Easy Steps

  36. High-level Code Structure and Class Relationships

  37. How to Create a Custom Adapter

  38. Two Custom Adapter Examples

  39. Multiple Adapter Synchronization

  40. Automated Phasor Tag Naming Convention

  41. About the Signal Reference Field

  42. Processing openPDC data with Hadoop

  43. Code Change Notes

    Bottom notes:

  44. Nightly Builds

  45. integrated within Visual Studio

The following links say "Not Found (Error 404):

  1. Default openPDC Ports

The following links is old site:

  1. PMU Connection Tester

Related Issues:

19 , #28 .

ritchiecarroll commented 5 years ago

I'm not getting this error - even if I open in an incognito window?

ritchiecarroll commented 5 years ago

We can grant you write access if you have time to assist with corrections... Just let us know.

Thanks, Ritchie

avs009 commented 5 years ago

I'm not getting this error - even if I open in an incognito window?

I already tested in incognito window, and it's produce same error reported.

We can grant you write access if you have time to assist with corrections... Just let us know.

Thanks, Ritchie

I will be happy, if can help.

ritchiecarroll commented 5 years ago

I sent you an invitation - let me know what you find... Thanks!

avs009 commented 5 years ago

Just for take sure what i will do, these pages exist in folder openPDC/tree/master/Source/Documentation/wiki.

Can i just update the link for that, or is best copy and paste the content?

In the second option, every update need to be done inside git wiki by me or another person.

Now i am reading all comments from @ajstadlin related about this.

ritchiecarroll commented 5 years ago

Try updating the link and see if that works for you... but let's just try one or two since I am not sure what's broken here - you might fix it for you and break it for me :-)

AJ did all this work in converting this documentation over from CodePlex - so he's a good contact - and I am sure he'd appreciate some help on maintaining this work (just as we do!)

Thanks, Ritchie

ritchiecarroll commented 5 years ago

Looks like your updates are working - thanks! I'll let you keep at it and I will close this issue for now.

Ritchie

avs009 commented 5 years ago

Now i see more clarification about what we can do with the git wiki. They already has a private repository in Git Wiki Repository and the best way to do some is migrate from master openPDC/tree/master/Source/Documentation/wiki.

ritchiecarroll commented 5 years ago

That would work - but there would be "many" links to update and documentation to copy - but if you are up for it? @StephenCWills @ajstadlin thoughts?

avs009 commented 5 years ago

I will do some tests with a private repository in wiki repo first, to take sure if need to update links or not.

StephenCWills commented 5 years ago

I believe that the primary limitation with the wiki repository is that you can't easily do forks, and you can't submit pull requests. The best workaround I've seen involves creating another separate repo to maintain the documentation and then syncing that repo with the wiki repo, and that sounds like a pain. Also, it appears there is an option to expose the wiki repo to any and all GitHub users, which I guess allows for more collaboration at the expense of security. That said, since we tend to give out write access to our repositories, this may not be as big of an issue as having to update all the links.

We also have the option of simply replacing the homepage of the wiki repository with a link to the appropriate location in the main repo. This would avoid the pull request problem, the effort of updating links, and the issue of maintaining the documentation in two separate places. The only real drawback would be that the history for the documentation will be kept in the main repo instead of being cleanly separated in its own repo, but Git tools tend to be pretty good about allowing you to filter those down.

As a third option, we could turn off the wiki repo for this repository and rely on the fact that the README.md has a link to the appropriate location for the documentation in the main repo. It's not front-and-center like the Wiki tab is, but it is the first place people tend to look for information when they browse to a new project. This has the same pros and cons as the previous option.

I think it would be okay with opening up the wiki to all GitHub users just to make it as easy as possible to contribute. We'd just have to be sure to maintain a local copy just in case.

avs009 commented 5 years ago

I am back, the migration is possible, but all the links must be updated without extension ".md", a simple "sed command" can do this.

As @StephenCWills says, the wiki repo not able to submit merge request, users always see the master version of repo.

Is able to create branches, but need to manual merge with master, there's no web interface to see changes between branches.

All users are able to clone the wiki repo, i think if they need update some terms, simple download the page and submit the changed file or a patch in an issue.

I think the best option is migrate all documentation to wiki repo, that's is worst option because need a large review but I'm willing to do.

StephenCWills commented 5 years ago

@avs009, If you're willing, I say go for it. I like the idea of having the documentation in the wiki repo.

ajstadlin commented 5 years ago

The one struggle I had in migrating the documentation from CodePlex was with how to do relative URLs consistently - given my skills level at the time. Anything that makes the documentation more portable is good, in my opinion.

I think it is great when others contribute to the documentation - and fix any of my artifacts!

//aj