From 1487bcf57f7edfddf2e195d4af47ee895fa98258 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Alexandru=20B=C4=83lu=C8=9B?= Date: Sat, 15 Dec 2018 00:44:50 +0100 Subject: [PATCH 1/4] docs: Fix instructions for installing the flatpak Runtime Sdk By adding a `/` we filter out org.pitivi.Pitivi.Codecs. --- docs/Bug_reporting.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/Bug_reporting.md b/docs/Bug_reporting.md index 16ea2af7f..b57065e2f 100644 --- a/docs/Bug_reporting.md +++ b/docs/Bug_reporting.md @@ -100,7 +100,7 @@ gdb python3 -ex "run $PITIVI_REPO_DIR/bin/pitivi" ``` GNOME_REPO=$(flatpak info org.gnome.Platform//3.24 | grep Origin | awk '{ print $2 }') -for i in $(flatpak list | grep org.pitivi.Pitivi | awk '{ print $1 }'); do +for i in $(flatpak list | grep org.pitivi.Pitivi/ | awk '{ print $1 }'); do flatpak install --user $GNOME_REPO $(flatpak info $i |grep Runtime |awk '{ print $2 }' |sed s/Platform/Sdk/) flatpak update --user $(flatpak info $i |grep Runtime |awk '{ print $2 }' |sed s/Platform/Sdk/) flatpak install --user $GNOME_REPO $(flatpak info $i |grep Runtime |awk '{ print $2 }' |sed s/Platform/Sdk.Debug/) -- GitLab From d8a35fadc5757f72c67adac449fdc349471a672e Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Alexandru=20B=C4=83lu=C8=9B?= Date: Sat, 15 Dec 2018 00:50:14 +0100 Subject: [PATCH 2/4] docs: Update testing A `-t` argument was missing. --- docs/Testing.md | 16 ++++++++-------- docs/index.md | 2 +- 2 files changed, 9 insertions(+), 9 deletions(-) diff --git a/docs/Testing.md b/docs/Testing.md index f13ecb77c..e19272230 100644 --- a/docs/Testing.md +++ b/docs/Testing.md @@ -12,27 +12,27 @@ you want to test more thoroughly. ## Unit tests -You can run the unit tests with: +You can run the unit tests with one of: ``` -ninja -C mesonbuild/ test +$ ptvtests ``` If you want to run only one particular unit test, use (assuming you are in -our flatpak based environment): +our flatpak based development environment): ``` -ptvtests tests.test_project.TestProjectManager.testLoadProjectFailedUnknownFormat +$ ptvtests -t tests.test_project.TestProjectManager.testLoadProjectFailedUnknownFormat ``` Listing tests: ``` -ptvtests -L +$ ptvtests -L ``` -NOTE: If you are not in our environment, replace `ptvtests` with -`gst-validate-launcher tests/ptv_testsuite.py`.) +NOTE: If you are not in our dev env, replace `ptvtests` with +`gst-validate-launcher tests/ptv_testsuite.py`. ### Writing unit tests @@ -69,5 +69,5 @@ each time Pitivi is used. You can run the integration tests with: ``` -tests/validate-tests/runtests +$ tests/validate-tests/runtests ``` diff --git a/docs/index.md b/docs/index.md index 7e3850713..e594b94a3 100644 --- a/docs/index.md +++ b/docs/index.md @@ -37,7 +37,7 @@ on the website (includes a “Why contribute to Pitivi?” section). - [Setup development environment](HACKING.md) (official and easiest way to get your testing/development environment running, with pre-built dependencies) -- The [test suite](Testing.md) (outdated) +- The [test suite](Testing.md) ## Ways to communicate -- GitLab From 1d18ca0b68e4795121c7726e2ba5edaa79fad111 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Alexandru=20B=C4=83lu=C8=9B?= Date: Sat, 15 Dec 2018 00:54:42 +0100 Subject: [PATCH 3/4] docs: Update past GSoCs --- docs/Past_GSoCs.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/docs/Past_GSoCs.md b/docs/Past_GSoCs.md index 641f74dd1..4a8ff1cd9 100644 --- a/docs/Past_GSoCs.md +++ b/docs/Past_GSoCs.md @@ -10,8 +10,8 @@ get involved. main UI has been refactored into the EditorPerspective, and the welcome dialog has been replaced by a new gorgeous and modern [GreeterPerspective](https://harishfulara07.wordpress.com/2018/08/13/gsoc-2018-final-report-pitivi-ui-polishing/). -- [Suhas Nayak](https://suhas2go.github.io) finished the slow motion - support in [GES][GES.md]. +- [Suhas Nayak](https://suhas2go.github.io) worked on the slow motion + support in [GES](GES.md), but had to interrupt. - [Yatin Maan](https://yatinmaan.github.io/) implemented support for [Scaled Proxies](https://yatinmaan.github.io/2018/08/14/GSoC-18-Final-Report/). -- GitLab From 47131b3991fbe0f34f5cdbd37f8ccd1f07959e04 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Alexandru=20B=C4=83lu=C8=9B?= Date: Sat, 15 Dec 2018 01:26:42 +0100 Subject: [PATCH 4/4] docs: Update the top page --- docs/index.md | 46 +++++++++++++++------------------------------- 1 file changed, 15 insertions(+), 31 deletions(-) diff --git a/docs/index.md b/docs/index.md index e594b94a3..046c116a5 100644 --- a/docs/index.md +++ b/docs/index.md @@ -16,55 +16,39 @@ To edit the website edit the markdown files in our git repo in the [User's Manual]: http://pitivi.org/manual/ [developer instructions]: HACKING.md -# Contributors' documentation +# We need your help -See the [Developer documentation](HACKING.md) -page for a complete listing of documentation aimed at contributing to -Pitivi. Here is a small overview/some starting points taken from that -category: +See the [Contributing](http://www.pitivi.org/?go=contributing) page +on the website for what you can contribute, and “Why contribute to +Pitivi?”. -- [Roadmap](Roadmap.md) (long-term plans) -- [Architecture](Architecture.md): where does Pitivi fit? What +- [Goals](Goals.md) ― mission statement, vision +- [Roadmap](Roadmap.md) ― long-term plans +- [Architecture](Architecture.md) ― Where does Pitivi fit? What are all those components? -- [Brainstorming](design.md) (UI mockups and “future” features only!) -See also the [Contributing](http://www.pitivi.org/?go=contributing) page -on the website (includes a “Why contribute to Pitivi?” section). -## Tools to help you get started +## Getting started -- [Git](Git.md) -- [Setup development environment](HACKING.md) (official and - easiest way to get your testing/development environment running, - with pre-built dependencies) +- [Tasks for newcomers](https://gitlab.gnome.org/GNOME/pitivi/issues?label_name%5B%5D=4.+Newcomers) +- Setting up the [development environment](HACKING.md) - The [test suite](Testing.md) +- [Git](Git.md) ## Ways to communicate - [Reporting bugs](Bug_reporting.md) - IRC: [\#pitivi](irc://irc.freenode.net/pitivi) on irc.freenode.net -- Our [Google+ page](https://plus.google.com/+pitivi) or - [Twitter](https://twitter.com/pitivi) account. Do *not* report bugs +- Our [Twitter](https://twitter.com/pitivi) account. Do *not* report bugs there, use our bug tracker instead! - [The people](The_people.md) (who does what) # Random stuff -- [Goals](Goals.md) (mission statement, vision) -- [Project history](Project_history.md) - rumors of our death - have been greatly exaggerated... :) -- [Current events](Current_events.md) - releases, meetings, +- [Project history](Project_history.md) ― how did we get here +- [Current events](Current_events.md) ― releases, meetings, talks ... See also the [planet](http://www.pitivi.org/planet) for news about the project. - [Why Python?](design/Why_python.md) -- [Praise](Praise.md) - a page to list some of the praises and - positive comments we received +- [Praise](Praise.md) ― Some of the praises and positive feedback - [Google Summer of Code](Google_Summer_of_Code.md) - -# Pages that need to be reworked/deleted - -The pages in these categories need to be reworked. Help is welcome! -Also, feel free to tag pages with these categories should you find that -a page is woefully incomplete or outdated: - -- [Probably obsolete](attic.md) -- GitLab