Skip to content
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.

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

Already on GitHub? Sign in to your account

Added Change Log to the website #204

Merged
merged 3 commits into from Jul 5, 2019

Conversation

@krisnaw
Copy link
Contributor

@krisnaw krisnaw commented Jun 27, 2019

Q A
Bug fix? no
New feature? no
Fixed tickets #107

Hi guys, 馃檹馃徑apologies for the delay
I've added new page for Change Log that can be accessed from the navigation menu and docs

@olivernybroe
Copy link
Sponsor Collaborator

@olivernybroe olivernybroe commented Jun 28, 2019

@krisnaw nice to see a pr for this!

Would it be possible to get the changelog which is stored in the root of the project so we don't have to update two changelogs each time? :)

@krisnaw
Copy link
Contributor Author

@krisnaw krisnaw commented Jun 28, 2019

Hi @olivernybroe let me try if that possible

@krisnaw
Copy link
Contributor Author

@krisnaw krisnaw commented Jul 2, 2019

Hi @olivernybroe do you have any advise? I've tried to point out the Changelog, but I think VuePress can't access the files outside the root directory.
I was thinking if possible to copy the Change log to Vuepress directory during the Travis CLI build

@Jibbarth
Copy link
Collaborator

@Jibbarth Jibbarth commented Jul 2, 2019

@krisnaw Thanks for working on this.

As far I know, it's not Travis which deploy the docs. (https://github.com/nunomaduro/phpinsights/blob/master/.travis.yml)

Did you try with symbolic link ? Or may the changelog page can grab the CHANGELOG.md content ?

@nunomaduro What your thought about this ? How the doc is deployed ?

@nunomaduro
Copy link
Owner

@nunomaduro nunomaduro commented Jul 2, 2019

symbolic link maybe a good idea. Let's try it.

@krisnaw
Copy link
Contributor Author

@krisnaw krisnaw commented Jul 3, 2019

Hi guys, thanks for the advice

I've tried using symbolic link but no luck, it seems the web pack won't read the files.
I've tried this solution as well

Step to reproduce

  1. From outside phpinsight directory, ln -s phpinsights/CHANGELOG.md phpinsights/docs/
  2. run yarn run vuepress dev

@nunomaduro
Copy link
Owner

@nunomaduro nunomaduro commented Jul 3, 2019

Hummmm, How about a composer post install/update that copy/pasts the changelog in that folder? And we can also use .gitignore to ignore the copy pasted file.

@olivernybroe
Copy link
Sponsor Collaborator

@olivernybroe olivernybroe commented Jul 4, 2019

What if you make the symbolic link in the other direction, so the root edition of the changelog is actually a symbolic link?

@olivernybroe
Copy link
Sponsor Collaborator

@olivernybroe olivernybroe commented Jul 4, 2019

Another solution is to do like vuepress own documentation does and have hyperlink to the .md file. That's a quick and easy solution, however not as pretty as having it actually in the docs.

@krisnaw
Copy link
Contributor Author

@krisnaw krisnaw commented Jul 4, 2019

So I've tried @nunomaduro advice by adding scripts like to the composer and its works.

        "post-root-package-install": [
            "@php -r \"copy('CHANGELOG.md', 'docs/CHANGELOG.md');\""
        ]

@nunomaduro
Copy link
Owner

@nunomaduro nunomaduro commented Jul 4, 2019

@krisnaw Great, can you update the pull request?

@nunomaduro
Copy link
Owner

@nunomaduro nunomaduro commented Jul 5, 2019

Thank you for this.

@nunomaduro nunomaduro merged commit fc27105 into nunomaduro:master Jul 5, 2019
1 check was pending
@Jibbarth Jibbarth mentioned this pull request Jul 5, 2019
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Linked issues

Successfully merging this pull request may close these issues.

None yet

4 participants